com.ptc.windchill.cadx.move
Class WFMoveTemplateProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              com.ptc.windchill.cadx.common.pageBuilder.ActionPageFormProcessor
                  com.ptc.windchill.cadx.move.WFMoveTemplateProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class WFMoveTemplateProcessor

extends ActionPageFormProcessor

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	DESC_RESOURCE
static long	EXTERNALIZATION_VERSION_UID
static String	MOVE_ALL_VERSIONS
private static String	MOVE_ALL_VERSIONS_JS
private HashMap	notValidObjects
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	RUN_IN_BACKGROUND
private static String	RUN_IN_BACKGROUND_JS
(package private) static long	serialVersionUID
private static boolean	VERBOSE
private static String	WORKSPACE

Fields inherited from class com.ptc.windchill.cadx.common.pageBuilder.ActionPageFormProcessor

REFERER_URL

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

ACTION, CLASS, CODEBASE, 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

WFMoveTemplateProcessor()

Method Summary

private static ArrayList	_getUiControls()
void	getContainerOID(Properties properties, Locale locale, OutputStream os)
void	getFormProcessorURL(Properties properties, Locale locale, OutputStream os) Supported API: false
String	getHasInvalidObjectsStatusMessage(Locale locale) Method that should return the message tio display in the status area when the page has objects that are not valid for the given action.
private String	getMoveAllVersions()
void	getPageHeaderJavascript(Properties properties, Locale locale, OutputStream os) gets the data that will go into the header section of the HTML.
void	getRefferingUrl(Properties properties, Locale locale, OutputStream os) Supported API: false
private String	getRunInBackground()
boolean	isValidActionObject(Persistable object) Supported API: false
FilteredTableRowDescriptor	newTableRowDescriptor(Persistable object, Properties props, int includedAs, String includedBy, ActionEnvironment env) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WFMoveTemplateProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
ArrayList	registerRuleDescriptors(Locale locale) Method that will set the ruleDescriptors value Supported API: false
Class	registerTableRowDescriptorClass() Supported API: false
ArrayList	registerTables(Locale locale) This method can be used to register the tables that exist in a given page.
ArrayList	registerUiControls() Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class com.ptc.windchill.cadx.common.pageBuilder.ActionPageFormProcessor

filterOnConfigSpec, filterTableData, getContext, getContext, getDateFormatJS, getDocConfigSpec, getEditWSConfigSpecHTML, getEnvironment, getFormData, getFormDataProperty, getFormDataUsedInInitPageFromFormData, getIncludedAsJSVariables, getIncludedAsLabelsJS, getIsPJL, getLocale, getPartConfigSpec, getPJLEndSpan, getPJLStartSpan, getProcessorURL, getReferingURL, getReferingURL, getRuleDescriptors, getRuleLabel, getRulesArrayJS, getRuleValues, getTableDIV, getTables, getUiControls, getUiControlValue, getUiControlValue, getWorkspace, initPageData, initPageFromFormData, isRedirectToReferingPage, readVersion, setEnvironment, setRedirectToReferingPage, setRuleDescriptors, setTables, updateRuleDescriptors

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, 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, 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

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

WORKSPACE

private static String WORKSPACE

notValidObjects

private HashMap notValidObjects

MOVE_ALL_VERSIONS

public static final String MOVE_ALL_VERSIONS

See Also:

Constant Field Values

MOVE_ALL_VERSIONS_JS

private static final String MOVE_ALL_VERSIONS_JS

See Also:

Constant Field Values

DESC_RESOURCE

private static final String DESC_RESOURCE

See Also:

Constant Field Values

RUN_IN_BACKGROUND

public static final String RUN_IN_BACKGROUND

See Also:

Constant Field Values

RUN_IN_BACKGROUND_JS

private static final String RUN_IN_BACKGROUND_JS

See Also:

Constant Field Values

Constructor Detail

WFMoveTemplateProcessor

public WFMoveTemplateProcessor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

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 ActionPageFormProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

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 ActionPageFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

getRefferingUrl

public void getRefferingUrl(Properties properties,
                            Locale locale,
                            OutputStream os)
                     throws WTException

Supported API: false

Parameters:

properties -

locale -

os -

Throws:

WTException

getFormProcessorURL

public void getFormProcessorURL(Properties properties,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Supported API: false

Parameters:

properties -

locale -

os -

Throws:

WTException

registerRuleDescriptors

public ArrayList registerRuleDescriptors(Locale locale)
                                  throws WTException

Method that will set the ruleDescriptors value

Supported API: false

Specified by:

registerRuleDescriptors in class ActionPageFormProcessor

Parameters:

locale -

Returns:

ArrayList

Throws:

WTException

registerTableRowDescriptorClass

public Class registerTableRowDescriptorClass()
                                      throws WTException

Supported API: false

Specified by:

registerTableRowDescriptorClass in class ActionPageFormProcessor

Returns:

Class

Throws:

WTException

newTableRowDescriptor

public FilteredTableRowDescriptor newTableRowDescriptor(Persistable object,
                                                        Properties props,
                                                        int includedAs,
                                                        String includedBy,
                                                        ActionEnvironment env)
                                                 throws WTException

Supported API: false

Specified by:

newTableRowDescriptor in class ActionPageFormProcessor

Parameters:

object -

props -

includedAs -

includedBy -

env -

Returns:

FilteredTableRowDescriptor

Throws:

WTException

registerUiControls

public ArrayList registerUiControls()

Supported API: false

Specified by:

registerUiControls in class ActionPageFormProcessor

Returns:

ArrayList

isValidActionObject

public boolean isValidActionObject(Persistable object)
                            throws WTException

Supported API: false

Specified by:

isValidActionObject in class ActionPageFormProcessor

Parameters:

object -

Returns:

boolean

Throws:

WTException

getHasInvalidObjectsStatusMessage

public String getHasInvalidObjectsStatusMessage(Locale locale)

Method that should return the message tio display in the status area when the page has objects that are not valid for the given action.

Supported API: false

Specified by:

getHasInvalidObjectsStatusMessage in class ActionPageFormProcessor

Parameters:

locale -

Returns:

String

registerTables

public ArrayList registerTables(Locale locale)
                         throws WTException

This method can be used to register the tables that exist in a given page. Tables are identified by an id and each table can have its own set of rows (however, rows can be in more then one table). If only one table is present in the page, then it is not required to register the table as it will be done automatically by ActionPageFormProcessor (it will call TableDescriptor.newSingleTable()).

Supported API: false

Specified by:

registerTables in class ActionPageFormProcessor

Parameters:

locale -

Returns:

ArrayList

Throws:

WTException

getPageHeaderJavascript

public void getPageHeaderJavascript(Properties properties,
                                    Locale locale,
                                    OutputStream os)
                             throws WTException

Description copied from class: ActionPageFormProcessor

gets the data that will go into the header section of the HTML. All sunclasses of this class that override this method must call super first.

Supported API: false

Overrides:

getPageHeaderJavascript in class ActionPageFormProcessor

Parameters:

properties -

locale -

os -

Throws:

WTException

getMoveAllVersions

private String getMoveAllVersions()

_getUiControls

private static ArrayList _getUiControls()

getRunInBackground

private String getRunInBackground()

getContainerOID

public void getContainerOID(Properties properties,
                            Locale locale,
                            OutputStream os)
                     throws WTException

Throws:

WTException