wt.workflow.work
Class AssociatedProcessProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.workflow.WorkflowProcessor
                  wt.workflow.TableTemplateProcessor
                      wt.workflow.work.AssociatedProcessProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TableProcessor, TemplateProcessor

public class AssociatedProcessProcessor

extends TableTemplateProcessor

Class AssociatedProcessProcessor creates an html page displaying attributes of the workflow processes associated with the business object specified by the OID parameter of the URL.

See Also:

AssociatedProcessOwner, wt.workflow.work.ProcessName, wt.workflow.work.ProcessState, wt.workflow.work.ProcessLoadAction,



Supported API: false

Extendable: true, Serialized Form

Field Summary

protected static String	CODEBASE
private static ResourceBundle	rb
private static String	RESOURCE Resources for localizing message text
private static boolean	VERBOSE

Fields inherited from class wt.workflow.TableTemplateProcessor

COLUMN_DEFINITION, GROUPBY_SELECTOR, LOCALE, MODEL, NO_GROUPKEY, NO_SORTKEY, sortableAttributes, SORTBY_SELECTOR

Fields inherited from class wt.workflow.WorkflowProcessor

fontHeader, t1bgcolhead, t1bgevenrow, t1fcolhead, TABLE_ATTRIBUTES, TABLE_DATA_ATTRIBUTES, TABLE_DATA_FONT, TABLE_DATA_ODD_ATTRIBUTES, TABLE_HEAD_ATTRIBUTES, TABLE_HEAD_FONT, tableEvenRow, tableHeader, tableOddRow

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, EXTERNALIZATION_VERSION_UID, OLD_FORMAT_VERSION_UID, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID

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

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

AssociatedProcessProcessor(Object context)
Constructs a AssociatedProcessProcessor.

Method Summary

void	createTableButton(Properties parameters, Locale locale, OutputStream os) Create the button to create a new table with the supplied customizations
void	createTableForm(Properties parameters, Locale locale, OutputStream os) Create the FORM construct to specify the url to invoke a new table
WTTableModel	createTableModel(String loadAction, Vector groupBy, Vector sortBy, WTObject contextObject, Locale locale) This method is used to construct a worklist on the server and return it to the client.
WTTableModel	getModel(Locale locale) Create a WTTableModel containing information about the workflow procesess related to the context object specified by the OID paramater of the URL
HTMLTemplate	getTemplate(Vector preferences)
void	handleRequest(HTTPRequest req, HTTPResponse resp) This method handles HTTP GET requests to produce an HTML page which enables the user to initiate a workflow process based on the previously selected workflow template The format of the HTML output is determined by the WorkList template.
void	objectNameHeadline(Properties parameters, Locale locale, OutputStream os) Headline for the table identifying the object used in all the displayed processes
void	pageTitle(Properties parameters, Locale locale, OutputStream os) Create a localized title for the page

Methods inherited from class wt.workflow.TableTemplateProcessor

columnHeaders, formatSeparatorRow, getDataSetKey, getGroupKey, getNumberOfColumns, getSortableAttributes, getSortKey, groupBySelector, setDataSetKey, setGroupKey, setNumberOfColumns, setSortableAttributes, setSortKey, sortBySelector, tableItems

Methods inherited from class wt.workflow.WorkflowProcessor

columnLabel, createActionButton, createObjectLink, getStyleSheetProps, tableCell, tableCell, tableCellBold, tableOddCell

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContentHolder, getContextualValue, getDefaultPath, getDelim, getDnDAppletTags, getEnumeratedTypeMenu, getFormat, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getLastUpdated, getMessageURL, getObjectIdentity, getPreferenceValue, getPrimary, getPrimary, getPrimaryAttribute, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getSize, getTargetType, getURLTabLink, getWTContainerRef, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readExternal, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder, writeExternal

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, 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, 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, readContext, 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

CODEBASE

protected static String CODEBASE

RESOURCE

private static final String RESOURCE

Resources for localizing message text

See Also:

Constant Field Values

rb

private static final ResourceBundle rb

Constructor Detail

AssociatedProcessProcessor

public AssociatedProcessProcessor()

A no argument constructor with no side effects.

AssociatedProcessProcessor

public AssociatedProcessProcessor(Object context)

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

Parameters:

context - The contextual object of the AssociatedProcessProcessor.

Method Detail

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Throws:

WTException

handleRequest

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

This method handles HTTP GET requests to produce an HTML page which enables the user to initiate a workflow process based on the previously selected workflow template The format of the HTML output is determined by the WorkList template.

Specified by:

handleRequest in interface TemplateProcessor

Overrides:

handleRequest in class GenerateFormProcessor

Parameters:

req - HTTPRequest

resp - HTTPResponse

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

objectNameHeadline

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

Headline for the table identifying the object used in all the displayed processes

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

createTableForm

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

Create the FORM construct to specify the url to invoke a new table

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

getModel

public WTTableModel getModel(Locale locale)
                      throws WTException

Create a WTTableModel containing information about the workflow procesess related to the context object specified by the OID paramater of the URL

Returns:

WTTable Model with the associated proceeses data

Throws:

WTException

createTableModel

public WTTableModel createTableModel(String loadAction,
                                     Vector groupBy,
                                     Vector sortBy,
                                     WTObject contextObject,
                                     Locale locale)
                              throws WTException

This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

Supported API: false

Parameters:

loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.

groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.

sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.

Returns:

WTTableModel

Throws:

WTException

createTableButton

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

Create the button to create a new table with the supplied customizations

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