wt.lifecycle.history
Class HistoryRowProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.lifecycle.history.HistoryRowProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class HistoryRowProcessor

extends BasicTemplateProcessor

Provide Windchill script support for the HistoryRow html template.

Supported API: false

Extendable: false

See Also:

TemplateProcessor, Serialized Form

Field Summary

private static String	CLASSNAME
private static String	CRITERION_ROW_HTML_TEMPLATE
private static String	CRITERION_TITLE_HTML_TEMPLATE
private static LifeCycleHistory	myHistory
private static LifeCycleManaged	myObject
private static String	RESOURCE
private static String	ROW_HTML_TEMPLATE
private static String	SIGNATURE_ROW_HTML_TEMPLATE
private static String	SIGNATURE_TITLE_HTML_TEMPLATE
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

HistoryRowProcessor()
A no argument constructor.

HistoryRowProcessor(LifeCycleHistory history)
Constructs a HistoryRowProcessor object.

HistoryRowProcessor(LifeCycleManaged lcm, LifeCycleHistory history)
Constructs a HistoryRowProcessor object.

Method Summary

void	getAction(Properties properties, Locale locale, OutputStream os) Outputs the Action found in the LifeCycle History.
void	getActorName(Properties properties, Locale locale, OutputStream os) Outputs the name of the Actor found in the LifeCycle History.
void	getCriteria(Properties properties, Locale locale, OutputStream os) Retrieve all the criteria associated with a Life Cycle History.
void	getLifeCycleStateName(Properties properties, Locale locale, OutputStream os) Outputs the Life Cycle state found in the LifeCycle History.
void	getLifeCycleTemplateName(Properties properties, Locale locale, OutputStream os) Outputs the Life Cycle Template name found in the LifeCycle History.
void	getPhaseName(Properties properties, Locale locale, OutputStream os) Outputs the name of the phase found in the Life Cycle History.
void	getSignatures(Properties properties, Locale locale, OutputStream os) Retrieve all the signatures associated with a Life Cycle History.
void	getTeamTemplateIdentity(Properties properties, Locale locale, OutputStream os) Outputs the team identity found in the Life Cycle History.
HTMLTemplate	getTemplate(Vector preferences) Return an initialized HTMLTemplate.
void	handleRequest(HTTPRequest req, HTTPResponse resp) This method handles HTTP GET requests to produce an HTML page for the context object.

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

CLASSNAME

private static String CLASSNAME

myHistory

private static LifeCycleHistory myHistory

myObject

private static LifeCycleManaged myObject

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

ROW_HTML_TEMPLATE

private static String ROW_HTML_TEMPLATE

CRITERION_ROW_HTML_TEMPLATE

private static String CRITERION_ROW_HTML_TEMPLATE

SIGNATURE_ROW_HTML_TEMPLATE

private static String SIGNATURE_ROW_HTML_TEMPLATE

CRITERION_TITLE_HTML_TEMPLATE

private static String CRITERION_TITLE_HTML_TEMPLATE

SIGNATURE_TITLE_HTML_TEMPLATE

private static String SIGNATURE_TITLE_HTML_TEMPLATE

VERBOSE

private static final boolean VERBOSE

Constructor Detail

HistoryRowProcessor

public HistoryRowProcessor(LifeCycleHistory history)

Constructs a HistoryRowProcessor object. The HistoryRowProcessor object is the context object used when building the Life Cycle History Row portion of the Life Cycle History window.

Parameters:

history - the LifeCycleHistory object of interest

HistoryRowProcessor

public HistoryRowProcessor(LifeCycleManaged lcm,
                           LifeCycleHistory history)

Constructs a HistoryRowProcessor object. The HistoryRowProcessor object is the context object used when building the Life Cycle History Row portion of the Life Cycle History window.

Parameters:

history - the LifeCycleHistory object of interest

HistoryRowProcessor

public HistoryRowProcessor()

A no argument constructor.

Method Detail

handleRequest

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

This method handles HTTP GET requests to produce an HTML page for the context object.

Parameters:

req -

resp -

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Throws:

WTException

getActorName

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

Outputs the name of the Actor found in the LifeCycle History. This method supports the 'getActorName' statement found in the appropriate html template. If the fullname of the user is not found, the name (userid) of the user is displayed instead.

Parameters:

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

os - The output stream.

getAction

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

Outputs the Action found in the LifeCycle History. This method supports the 'getAction' statement found in the appropriate html template.

Parameters:

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

os - The output stream.

getLifeCycleTemplateName

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

Outputs the Life Cycle Template name found in the LifeCycle History. This method supports the 'getLifeCycleTemplateName' statement found in the appropriate html template.

Parameters:

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

os - The output stream.

getLifeCycleStateName

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

Outputs the Life Cycle state found in the LifeCycle History. This method supports the 'getLifeCycleStateName' statement found in the appropriate html template.

Parameters:

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

os - The output stream.

getPhaseName

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

Outputs the name of the phase found in the Life Cycle History. This method supports the 'getPhaseName' statement found in the appropriate html template.

Parameters:

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

os - The output stream.

getTeamTemplateIdentity

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

Outputs the team identity found in the Life Cycle History. This method supports the 'getTeamTemplateIdentity' statement found in the appropriate html template.

Parameters:

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

os - The output stream.

getSignatures

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

Retrieve all the signatures associated with a Life Cycle History. This method supports the 'getSignatures' statement found in the appropriate html template. For each signature found, a row in the list is formatted by calling the HistorySignatureRow html template using the HistorySignatureRowProcessor context object.

Parameters:

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

os - The output stream.

getCriteria

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

Retrieve all the criteria associated with a Life Cycle History. This method supports the 'getCriteria' statement found in the appropriate html template. For each criteria found, a row in the list is formatted by calling the HistoryCriterionRow html template using the HistoryCriterionRowProcessor context object.

Parameters:

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

os - The output stream.