wt.workflow.work
Class NotificationMessageProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.workflow.work.NotificationMessageProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class NotificationMessageProcessor

extends BasicTemplateProcessor

implements Serializable

Provide Windchill script support for notification message html templates. In its current form this class was intended to support lifecycle notifications. At R2 this functionality was no longer needed. This class should be modified to support generic notification template processing. (bjg 11/24/98)

See Also:

TemplateProcessor, Serialized Form

Field Summary

private static String	CLASSNAME
private static String	CODEBASE
private Properties	m_UserMessages
LifeCycleManaged	myObject
Role	myRole
State	myState
private static String	ONLINE_HELP_KEY
private static String	PROPERTY
private static String	RESOURCE
private static boolean	VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, 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, EXTERNALIZATION_VERSION_UID, 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, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, 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

NotificationMessageProcessor()

NotificationMessageProcessor(LifeCycleManaged lcm, Role role, State state)
Deprecated. Since R2

Method Summary

void	addUserMessage(String key, String message) Add a message which can be retrieved by a Windchill script call in an html template.
void	getHelpURL(Properties properties, Locale locale, OutputStream os) Outputs a help URL that links to the appropriate online help file.
void	getOriginState(Properties properties, Locale locale, OutputStream os) Deprecated. Since R2
void	getRole(Properties properties, Locale locale, OutputStream os) Deprecated. Since R2
void	getURL(Properties properties, Locale locale, OutputStream os) Deprecated. Since R2
void	getUserMessage(Properties properties, Locale locale, OutputStream os) Messages can be stored by key in this template processor before an html template file is processed to generate a notification body.
String	getUserMessage(String key)
void	handleRequest(HTTPRequest req, HTTPResponse resp) The initial method called to initiate template processing, its parameters give access to the HTML request and response.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, 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, hiddenContextString, 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, readContext, readExternal, 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, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

myObject

public LifeCycleManaged myObject

myRole

public Role myRole

myState

public State myState

m_UserMessages

private Properties m_UserMessages

CLASSNAME

private static String CLASSNAME

PROPERTY

private static final String PROPERTY

See Also:

Constant Field Values

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

ONLINE_HELP_KEY

private static final String ONLINE_HELP_KEY

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

CODEBASE

private static final String CODEBASE

Constructor Detail

NotificationMessageProcessor

public NotificationMessageProcessor(LifeCycleManaged lcm,
                                    Role role,
                                    State state)

Deprecated. Since R2

Constructs a NotificationMessageProcessor object. The NotificationMessageProcessor object is the context object used when sending Life Cycle notification messages.

Parameters:

lcm - the LifeCycleManaged object of interest

role - the Role of interest

NotificationMessageProcessor

public NotificationMessageProcessor()

Method Detail

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

Description copied from interface: TemplateProcessor

The initial method called to initiate template processing, its parameters give access to the HTML request and response.

Supported API: true

Specified by:

handleRequest in interface TemplateProcessor

Parameters:

req -

resp -

Throws:

WTException

getRole

public void getRole(Properties properties,
                    Locale locale,
                    OutputStream os)

Deprecated. Since R2

Outputs the role name. This method supports the 'getRole' statement in the appropriate html template. It outputs the role name found in the associated context object.

Parameters:

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

os - The output stream.

getOriginState

public void getOriginState(Properties properties,
                           Locale locale,
                           OutputStream os)

Deprecated. Since R2

Outputs the 'origin' state name. This method supports the 'getOriginState' statement in the appropriate html template. It outputs the state name found in the associated context object. This 'origin' state is different from the current state of the object. If you call 'objectPropertyValue propertyName=lifeCycleState' you will receive the current state of the object at the time the notification message is created. If you call 'getOriginState' you will get the state that the notification is intended to execute against.

Parameters:

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

os - The output stream.

getURL

public void getURL(Properties properties,
                   Locale locale,
                   OutputStream os)

Deprecated. Since R2

Outputs a URL that links to the appropriate Life Cycle task. This method supports the 'getURL' statement in the appropriate html template. The person who receives a life cycle notification message is being asked to complete a task or function. The URL returned from this method links the receiver to the task they need to complete.

Parameters:

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

os - The output stream.

getHelpURL

public void getHelpURL(Properties properties,
                       Locale locale,
                       OutputStream os)

Outputs a help URL that links to the appropriate online help file. This method supports the 'getHelpURL' statement in the appropriate html template.

Parameters:

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

os - The output stream.

getUserMessage

public void getUserMessage(Properties properties,
                           Locale locale,
                           OutputStream os)

Messages can be stored by key in this template processor before an html template file is processed to generate a notification body. This method retrieves these messages by key and outputs them to the generated html stream. Example script tag: SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD