wt.change2.htmlclient
Class ChangeManagementFormProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.change2.htmlclient.ChangeManagementFormProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

DefaultChangeTaskProcessor

Deprecated. This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten on a JSP framework in an upcoming release. The form processor supports HTML generation for Windchill Change Management. Please refer to the chapter "Customizing Change Management" in the Windchill Customizer's Guide.

public class ChangeManagementFormProcessor

extends GenerateFormProcessor

implements Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	ACTION Deprecated.
private static String	CHANGE_MANAGEMENT_CREATE_TASK Deprecated.
private static String	CHANGE_MANAGEMENT_UPDATE_TASK Deprecated.
private static String	CHANGE_MANAGEMENT_VIEW_TASK Deprecated.
private static String	CLASS_NAME Deprecated.
private static String	CLASSNAME Deprecated.
private static String	CM_FORM_ACTION Deprecated.
private static String	CM_FORM_UPDATE_ACTION Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private static String	NAME Deprecated.
private static String	OID Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private static String	REFRESH_ACTION Deprecated.
private static String	REFRESH_CLASS Deprecated.
private static String	REFRESH_OID Deprecated.
private static String	RESOURCE Deprecated.
(package private) static long	serialVersionUID Deprecated.
private static String	UPDATE Deprecated.
private static boolean	VERBOSE Deprecated. Resources for localizing message text

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR

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

ChangeManagementFormProcessor()
Deprecated.

Method Summary

void	contextualValue(Properties parameters, Locale locale, OutputStream os) Deprecated. This call is used to output the value of the attribute identified by the property "propertyName" in the parameters argument.
void	createFormConstruct(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	displayChangeTask(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	escapeSymbol(String s) Deprecated.
void	pageTitle(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ChangeManagementFormProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, 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, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder

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

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

Deprecated.

Resources for localizing message text

OID

private static final String OID

Deprecated.

See Also:

Constant Field Values

ACTION

private static final String ACTION

Deprecated.

See Also:

Constant Field Values

CLASS_NAME

private static final String CLASS_NAME

Deprecated.

See Also:

Constant Field Values

REFRESH_CLASS

private static final String REFRESH_CLASS

Deprecated.

See Also:

Constant Field Values

REFRESH_ACTION

private static final String REFRESH_ACTION

Deprecated.

See Also:

Constant Field Values

REFRESH_OID

private static final String REFRESH_OID

Deprecated.

See Also:

Constant Field Values

NAME

private static final String NAME

Deprecated.

See Also:

Constant Field Values

UPDATE

private static final String UPDATE

Deprecated.

See Also:

Constant Field Values

CM_FORM_ACTION

private static final String CM_FORM_ACTION

Deprecated.

See Also:

Constant Field Values

CM_FORM_UPDATE_ACTION

private static final String CM_FORM_UPDATE_ACTION

Deprecated.

See Also:

Constant Field Values

CHANGE_MANAGEMENT_VIEW_TASK

private static final String CHANGE_MANAGEMENT_VIEW_TASK

Deprecated.

See Also:

Constant Field Values

CHANGE_MANAGEMENT_CREATE_TASK

private static final String CHANGE_MANAGEMENT_CREATE_TASK

Deprecated.

See Also:

Constant Field Values

CHANGE_MANAGEMENT_UPDATE_TASK

private static final String CHANGE_MANAGEMENT_UPDATE_TASK

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ChangeManagementFormProcessor

public ChangeManagementFormProcessor()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class GenerateFormProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class GenerateFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ChangeManagementFormProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

createFormConstruct

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

Deprecated.

(Windchill Script method) Initialize various elements necessary for the Change Management HTML user interface. This script method is one of the first methods invoked for any Change Management HTML page. It performs the following activities:

1. Move all information following the "?" in the browser location bar (called QueryString) to the form data. This is necessary if an update or create page immediately followed this page because the IntermediateAction.html template causes all of the form data to be moved to the QueryString.
2. Obtain the context object and reset it to be the parent Change Request This allows the user interface to always display the parent Change Request first. The FindChangeRequestDelegate is used to determine the parent Change Request.
3. Call FindChangeRequestDelegate.setHtmlClientState using the original context object. In the standard Windchill delegates this causes the original context object to be pre-expanded when the page is displayed in the browser.
4. Set the "update" form data property to the object reference for the original context object if the context action indicates update mode. This displays the original context object in an updatable mode.
5. Output the FORM tag to the browser. The name of the form is obtained from the value of the "name" parameter passed to this script call.
6. Output the following hidden form fields to the browser. These values are used by the JavaScript methods, which perform HTTP POST operations and cause the server to process the forms.
   • refreshAction - value is set to "ObjProps" if the original context action was an update action, the original context action otherwise
   • refreshOid - value is set to the object reference string of the parent change request
   • refreshClass - value is set to he class of the object being created. This will be null if there is a parent change request.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

displayChangeTask

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

Deprecated.

(Windchill Script method) Invokes a subtemplate at the current point in the HTML template. This script method inserts a template using one of the following context actions:

• CreateRequestTask, if the context object is null
• DefaultUpdateTask, if the current context action is AutoUpdateChangeObject
• DefaultViewTask, otherwise

Refer to codebase.change2.change2.properties to determine the HTML template and template processor used for each context action.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

pageTitle

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

Deprecated.

(Windchill Script method) This script method sets the browser page title for the Change Management HTML user interface. The page title reflects the current task that the user is performing.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

contextualValue

public void contextualValue(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException,
                            InvocationTargetException,
                            IllegalAccessException,
                            ClassNotFoundException,
                            InstantiationException

Deprecated.

Description copied from class: GenerateFormProcessor

This call is used to output the value of the attribute identified by the property "propertyName" in the parameters argument. If this property is found in the form data or query data, that value will be used otherwise the value from the database will be used.

Supported API: true

Overrides:

contextualValue in class GenerateFormProcessor

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

escapeSymbol

public String escapeSymbol(String s)

Deprecated.