wt.workflow.work
Class WfMessageProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.workflow.work.WfMessageProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class WfMessageProcessor

extends DefaultTemplateProcessor

See Also:

Serialized Form

Field Summary

(package private) String	message
private static ResourceBundle	rb
private static String	RESOURCE Resources for localizing message text
private static boolean	VERBOSE

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, EXTERNALIZATION_VERSION_UID, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, OLD_FORMAT_VERSION_UID

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, linkPrefix, LOCAL_SEARCH, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PRESENT_HELP_LABEL, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

WfMessageProcessor()
A no argument constructor with no side effects.

WfMessageProcessor(Object context)
Constructs a WfMessageProcessor.

Method Summary

void	messageText(Properties parameters, Locale locale, OutputStream os) Confirmation of the task complete or any exception which occurred.
void	pageTitle(Properties parameters, Locale locale, OutputStream os) Create a localized title for the page
void	readContext(HTTPRequest request) Description of the Method

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, handleRequest, hiddenContextString, readExternal, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERBOSE

private static boolean VERBOSE

message

String message

RESOURCE

private static final String RESOURCE

Resources for localizing message text

See Also:

Constant Field Values

rb

private static final ResourceBundle rb

Constructor Detail

WfMessageProcessor

public WfMessageProcessor()

A no argument constructor with no side effects.

WfMessageProcessor

public WfMessageProcessor(Object context)

Constructs a WfMessageProcessor. The contextual object of the instance is set to the object context.

Parameters:

context - The contextual object of the WfTaskCompleteProcessor.

Method Detail

readContext

public void readContext(HTTPRequest request)
                 throws WTException

Description copied from class: BasicTemplateProcessor

Description of the Method

Specified by:

readContext in interface ContextTranslator

Overrides:

readContext in class BasicTemplateProcessor

Parameters:

request - Description of the Parameter

Throws:

WTException - Description of the Exception

messageText

public void messageText(Properties parameters,
                        Locale locale,
                        OutputStream os)
                 throws WTException

Confirmation of the task complete or any exception which occurred.

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException

pageTitle

public void pageTitle(Properties parameters,
                      Locale locale,
                      OutputStream os)
               throws WTException

Create a localized title for the page

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException