wt.lifecycle.history
Class HistoryProcessor

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

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

CADDocLifeCycleHistoryProcessor

public class HistoryProcessor

extends BasicTemplateProcessor

Provide Windchill script support for the History 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	LIFECYCLE_VERBOSE_FLAG
private static String	MAIN_HTML_TEMPLATE
private static String	METHODNAME
private static LifeCycleManaged	myObject
private static int	PAGE_EXPIRATION
private static String	RESOURCE
private static String	ROW_HTML_TEMPLATE
private static String	SIGNATURE_ROW_HTML_TEMPLATE
private static String	URLCLASSNAME
private static String	URLMETHODNAME
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

HistoryProcessor()
A no argument constructor.

HistoryProcessor(LifeCycleManaged lcm)
Constructs a HistoryProcessor object.

Method Summary

static String	buildHistoryUrl(LifeCycleManaged object) Constructs a URL that links to the Life Cycle History.
protected void	generatePage(HTTPRequest req, HTTPResponse resp) Create the Life Cycle History window.
void	getHistory(Properties properties, Locale locale, OutputStream os) Retrieve the history of the LifeCycle Managed object.
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.
void	initialize(HTTPRequest req) Initialize the HTTPRequest

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

METHODNAME

private static String METHODNAME

MAIN_HTML_TEMPLATE

private static String MAIN_HTML_TEMPLATE

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

LIFECYCLE_VERBOSE_FLAG

private static String LIFECYCLE_VERBOSE_FLAG

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

URLCLASSNAME

private static String URLCLASSNAME

URLMETHODNAME

private static String URLMETHODNAME

myObject

private static LifeCycleManaged myObject

VERBOSE

private static final boolean VERBOSE

PAGE_EXPIRATION

private static final int PAGE_EXPIRATION

Constructor Detail

HistoryProcessor

public HistoryProcessor(LifeCycleManaged lcm)

Constructs a HistoryProcessor object. The HistoryProcessor object is the context object used when building the Life Cycle History window.

Parameters:

lcm - the LifeCycleManaged object of interest

HistoryProcessor

public HistoryProcessor()

A no argument constructor.

Method Detail

buildHistoryUrl

public static String buildHistoryUrl(LifeCycleManaged object)
                              throws WTException

Constructs a URL that links to the Life Cycle History. This is a convenience method for anyone that has to launch the Life Cycle History.

Throws:

WTException - throws WTException if the URL cannot be built

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

generatePage

protected void generatePage(HTTPRequest req,
                            HTTPResponse resp)
                     throws WTException,
                            IOException

Create the Life Cycle History window. This method handles HTTP GET requests to produce an HTML page which lists the entire history of a LifeCycle Managed Object. The format of the HTML output is determined by the History, HistoryRow, HistorySignatureRow and HistoryCriterionRow HTML templates.

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

IOException

initialize

public void initialize(HTTPRequest req)
                throws WTException

Initialize the HTTPRequest

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Throws:

WTException

getHistory

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

Retrieve the history of the LifeCycle Managed object. This method supports the 'getHistory' statement found in the appropriate html template. For each history object found, information is formatted by calling the HistoryRow, HistoryCriterionRow, and HistorySignatureRow html templates.

Parameters:

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

os - The output stream.