com.ptc.windchill.cadx.wsoption
Class WsprefTemplateProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              com.ptc.windchill.cadx.wsoption.WsprefTemplateProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class WsprefTemplateProcessor

extends GenerateFormProcessor

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	CREATE_WS_RESOURCE
static long	EXTERNALIZATION_VERSION_UID
private static String	NAV_TAB_ROOT_TREE_NAME_DEFAULT
private static String	NAV_TAB_ROOT_TREE_NAME_KEY
private static String	NAV_TAB_ROOT_TREE_NAME_PRO_INTRALINK
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	subSystemName
private static boolean	VERBOSE

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

WsprefTemplateProcessor()

Method Summary

void	getDefaultEPMDocFolder(Properties parameters, Locale locale, OutputStream os)
void	getDescription(Properties parameters, Locale locale, OutputStream os) Get the workspace description.
void	getEPMDocTargetFolderPath(Properties parameters, Locale locale, OutputStream os)
String	getSubSystemName() Get subSystemName and save as this object's state to avoid repeated lookup
void	getTagID(Properties parameters, Locale locale, OutputStream os) Based on the specified name for the tag, derive the tag id value
void	getWsDefaultDocLifeCycle(Properties parameters, Locale locale, OutputStream os)
void	getWsDefaultPartLifeCycle(Properties parameters, Locale locale, OutputStream os)
void	getWsDefaultProject(Properties parameters, Locale locale, OutputStream os)
void	getWsDefaultView(Properties parameters, Locale locale, OutputStream os)
void	getWsDefaultWTPartFolder(Properties parameters, Locale locale, OutputStream os)
void	getWTPartTargetFolderPath(Properties parameters, Locale locale, OutputStream os)
private boolean	isDisplayPropertiesForCandidateContainer() Return true if the workspace properties needs to be refreshed based on the user selected candidate container.
void	listContainers(Properties parameters, Locale locale, OutputStream os) List the name of containers which belongs to same solution context as the current workspace's container.
void	listDependencyOptions(Properties parameters, Locale locale, OutputStream os)
void	listDocLifeCycles(Properties parameters, Locale locale, OutputStream os)
void	listLifeCycles(Properties parameters, Locale locale, OutputStream os, String name)
void	listTeams(Properties parameters, Locale locale, OutputStream os)
void	listViews(Properties parameters, Locale locale, OutputStream os)
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(WsprefTemplateProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	renderDependencyProcessingType(Properties parameters, Locale locale, OutputStream os)
void	renderPartLifeCycles(Properties parameters, Locale locale, OutputStream os)
void	renderPartTargetFolder(Properties parameters, Locale locale, OutputStream os)
void	renderTab(Properties parameters, Locale locale, OutputStream os)
void	renderViews(Properties parameters, Locale locale, OutputStream os)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

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

NAV_TAB_ROOT_TREE_NAME_KEY

private static final String NAV_TAB_ROOT_TREE_NAME_KEY

See Also:

Constant Field Values

NAV_TAB_ROOT_TREE_NAME_PRO_INTRALINK

private static final String NAV_TAB_ROOT_TREE_NAME_PRO_INTRALINK

See Also:

Constant Field Values

NAV_TAB_ROOT_TREE_NAME_DEFAULT

private static final String NAV_TAB_ROOT_TREE_NAME_DEFAULT

See Also:

Constant Field Values

subSystemName

private String subSystemName

CREATE_WS_RESOURCE

private static final String CREATE_WS_RESOURCE

See Also:

Constant Field Values

Constructor Detail

WsprefTemplateProcessor

public WsprefTemplateProcessor()

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 GenerateFormProcessor

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 GenerateFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WsprefTemplateProcessor 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

listTeams

public void listTeams(Properties parameters,
                      Locale locale,
                      OutputStream os)

renderViews

public void renderViews(Properties parameters,
                        Locale locale,
                        OutputStream os)

listViews

public void listViews(Properties parameters,
                      Locale locale,
                      OutputStream os)

renderPartLifeCycles

public void renderPartLifeCycles(Properties parameters,
                                 Locale locale,
                                 OutputStream os)

listDocLifeCycles

public void listDocLifeCycles(Properties parameters,
                              Locale locale,
                              OutputStream os)

listLifeCycles

public void listLifeCycles(Properties parameters,
                           Locale locale,
                           OutputStream os,
                           String name)

renderPartTargetFolder

public void renderPartTargetFolder(Properties parameters,
                                   Locale locale,
                                   OutputStream os)

getWTPartTargetFolderPath

public void getWTPartTargetFolderPath(Properties parameters,
                                      Locale locale,
                                      OutputStream os)

getEPMDocTargetFolderPath

public void getEPMDocTargetFolderPath(Properties parameters,
                                      Locale locale,
                                      OutputStream os)

getWsDefaultProject

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

Throws:

WTException

getWsDefaultPartLifeCycle

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

Throws:

WTException

getWsDefaultDocLifeCycle

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

Throws:

WTException

getWsDefaultWTPartFolder

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

Throws:

WTException

getDefaultEPMDocFolder

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

Throws:

WTException

getWsDefaultView

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

Throws:

WTException

renderDependencyProcessingType

public void renderDependencyProcessingType(Properties parameters,
                                           Locale locale,
                                           OutputStream os)

getSubSystemName

public String getSubSystemName()

Get subSystemName and save as this object's state to avoid repeated lookup

getTagID

public void getTagID(Properties parameters,
                     Locale locale,
                     OutputStream os)

Based on the specified name for the tag, derive the tag id value

getDescription

public void getDescription(Properties parameters,
                           Locale locale,
                           OutputStream os)

Get the workspace description.

listDependencyOptions

public void listDependencyOptions(Properties parameters,
                                  Locale locale,
                                  OutputStream os)

listContainers

public void listContainers(Properties parameters,
                           Locale locale,
                           OutputStream os)

List the name of containers which belongs to same solution context as the current workspace's container. Pre-select the current workspace container.

renderTab

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

Throws:

WTException

isDisplayPropertiesForCandidateContainer

private boolean isDisplayPropertiesForCandidateContainer()

Return true if the workspace properties needs to be refreshed based on the user selected candidate container. When true, the potential property values are shown to the user for this container.