wt.part
Class MultilevelBomCompareQueryProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.part.MultilevelBomCompareQueryProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class MultilevelBomCompareQueryProcessor

extends GenerateFormProcessor

implements Externalizable

This template processor produces the HTML dialog to get parameters for the Multilevel BOM Compare report. It defines several WindchillScript methods.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	ACTION
static String	CLASS
private static String	CLASSNAME
static String	CONFIG_SPEC
static String	CONFIG_SPEC_OTHER
static long	EXTERNALIZATION_VERSION_UID
static String	FORM
protected static long	OLD_FORMAT_VERSION_UID
static String	PART
static String	PART1
static String	PART2
static String	PRODUCT_INSTANCE
private static String	RESOURCE
static String	RETURN_ACTION
static String	RETURN_OID
static String	RETURN_OID2
static String	RETURN_TEMPLATE
static String	RETURN_TEMPLATE_PROCESSOR
(package private) static long	serialVersionUID
static String	SOURCE_CONFIG_SPEC
static String	TARGET_CONFIG_SPEC
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

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

MultilevelBomCompareQueryProcessor()

Method Summary

String	getButton(String name, String value)
String	getButton(String name, String value, String onclick)
ConfigSpec	getConfigSpec(String encodedConfigSpec)
protected HTMLTemplate	getConfigSpecDisplayTemplate(ConfigSpec spec, Locale locale) Returns the HTMLTemplate for displaying the properties of the configuration specification
protected ServletSessionCookie	getCookie(String cookieName)
private String	getDataProperty(String key)
String	getFormDataProperty(String name)
String	getHiddenField(String name, String value)
private WTPartMaster	getPartMaster(String oidValue)
private String	getPartMaster1Oid()
private String	getPartMaster2Oid()
private WTProductInstance2	getProductInstance(String oidValue)
String	getQueryDataProperty(String name)
String	getSourceConfigSpecEncoding()
String	getTargetConfigSpecEncoding()
boolean	hasIdenticalSourceAndTarget()
boolean	hasTargetVersion()
void	outputCancelButton(Properties parameters, Locale locale, OutputStream os)
void	outputConfigSpecLink(Properties properties, Locale locale, OutputStream os) Outputs a link to modify the config spec.
void	outputGenerateReportButton(Properties parameters, Locale locale, OutputStream os)
void	outputHiddenFieldsForConfigSpecProcessor(Properties parameters, Locale locale, OutputStream os)
void	outputPartMaster2OidField(Properties parameters, Locale locale, OutputStream os)
void	outputPlanningDate(Properties properties, Locale locale, OutputStream os) Outputs a l10n representation of true/false in the configuration specification.
void	outputProductInstanceConfigSpecLink(Properties properties, Locale locale, OutputStream os)
void	outputSearchPartsButton(Properties parameters, Locale locale, OutputStream os)
void	outputSetConfigSpecButton(Properties parameters, Locale locale, OutputStream os)
void	outputSourceConfigSpecEncodingHiddenField(Properties parameters, Locale locale, OutputStream os)
void	outputSourceConfigSpecIdentity(Properties parameters, Locale locale, OutputStream os)
void	outputSourcePartIdentity(Properties parameters, Locale locale, OutputStream os)
void	outputTargetConfigSpecEncodingHiddenField(Properties parameters, Locale locale, OutputStream os)
void	outputTargetConfigSpecIdentity(Properties parameters, Locale locale, OutputStream os)
void	outputTargetPartIdentity(Properties parameters, Locale locale, OutputStream os)
void	outputTargetPartIdentityField(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(MultilevelBomCompareQueryProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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

SOURCE_CONFIG_SPEC

public static final String SOURCE_CONFIG_SPEC

See Also:

Constant Field Values

TARGET_CONFIG_SPEC

public static final String TARGET_CONFIG_SPEC

See Also:

Constant Field Values

FORM

public static final String FORM

See Also:

Constant Field Values

CLASS

public static final String CLASS

See Also:

Constant Field Values

ACTION

public static final String ACTION

See Also:

Constant Field Values

RETURN_ACTION

public static final String RETURN_ACTION

See Also:

Constant Field Values

RETURN_TEMPLATE

public static final String RETURN_TEMPLATE

See Also:

Constant Field Values

RETURN_TEMPLATE_PROCESSOR

public static final String RETURN_TEMPLATE_PROCESSOR

See Also:

Constant Field Values

CONFIG_SPEC

public static final String CONFIG_SPEC

See Also:

Constant Field Values

RETURN_OID

public static final String RETURN_OID

See Also:

Constant Field Values

RETURN_OID2

public static final String RETURN_OID2

See Also:

Constant Field Values

CONFIG_SPEC_OTHER

public static final String CONFIG_SPEC_OTHER

See Also:

Constant Field Values

PART1

public static final String PART1

See Also:

Constant Field Values

PART2

public static final String PART2

See Also:

Constant Field Values

PART

public static final String PART

See Also:

Constant Field Values

PRODUCT_INSTANCE

public static final String PRODUCT_INSTANCE

See Also:

Constant Field Values

VERBOSE

public static final boolean VERBOSE

See Also:

Constant Field Values

Constructor Detail

MultilevelBomCompareQueryProcessor

public MultilevelBomCompareQueryProcessor()

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(MultilevelBomCompareQueryProcessor 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

outputHiddenFieldsForConfigSpecProcessor

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

Throws:

WTException

getHiddenField

public String getHiddenField(String name,
                             String value)
                      throws WTException

Throws:

WTException

outputSourceConfigSpecEncodingHiddenField

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

Throws:

WTException

getTargetConfigSpecEncoding

public String getTargetConfigSpecEncoding()
                                   throws WTException

Throws:

WTException

outputTargetConfigSpecEncodingHiddenField

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

Throws:

WTException

getSourceConfigSpecEncoding

public String getSourceConfigSpecEncoding()
                                   throws WTException

Throws:

WTException

outputSourcePartIdentity

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

Throws:

WTException

outputTargetPartIdentity

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

Throws:

WTException

outputTargetPartIdentityField

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

Throws:

WTException

outputSourceConfigSpecIdentity

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

Throws:

WTException

getConfigSpecDisplayTemplate

protected HTMLTemplate getConfigSpecDisplayTemplate(ConfigSpec spec,
                                                    Locale locale)
                                             throws WTException

Returns the HTMLTemplate for displaying the properties of the configuration specification

Throws:

WTException

outputConfigSpecLink

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

Outputs a link to modify the config spec. This method is invoked as a Windchill script call in an HTML template. The given Properties object contains parameters of the script call. The following parameters can be given: "label" - specifies the label to use as the text of the HREF, "style" - specifies any style information used to format the link.

Parameters:

properties - the Properties object containing the script parameters

locale - the locale in which to display the link

os - the OutputStream to write the link to

outputProductInstanceConfigSpecLink

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

Throws:

WTException

outputPlanningDate

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

Outputs a l10n representation of true/false in the configuration specification.

Parameters:

properties - the Properties object containing the script parameters

locale - the locale in which to display the link

os - the OutputStream to write the link to

outputTargetConfigSpecIdentity

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

Throws:

WTException

outputSearchPartsButton

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

Throws:

WTException

outputSetConfigSpecButton

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

Throws:

WTException

outputGenerateReportButton

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

Throws:

WTException

outputCancelButton

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

Throws:

WTException

getDataProperty

private String getDataProperty(String key)

getFormDataProperty

public String getFormDataProperty(String name)
                           throws WTException

Throws:

WTException

getQueryDataProperty

public String getQueryDataProperty(String name)
                            throws WTException

Throws:

WTException

getPartMaster

private WTPartMaster getPartMaster(String oidValue)
                            throws WTException

Throws:

WTException

getProductInstance

private WTProductInstance2 getProductInstance(String oidValue)
                                       throws WTException

Throws:

WTException

getPartMaster1Oid

private String getPartMaster1Oid()
                          throws WTException

Throws:

WTException

getPartMaster2Oid

private String getPartMaster2Oid()
                          throws WTException

Throws:

WTException

outputPartMaster2OidField

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

Throws:

WTException

getConfigSpec

public ConfigSpec getConfigSpec(String encodedConfigSpec)
                         throws WTException

Throws:

WTException

getButton

public String getButton(String name,
                        String value)
                 throws WTException

Throws:

WTException

getButton

public String getButton(String name,
                        String value,
                        String onclick)
                 throws WTException

Throws:

WTException

hasTargetVersion

public boolean hasTargetVersion()
                         throws WTException

Throws:

WTException

hasIdenticalSourceAndTarget

public boolean hasIdenticalSourceAndTarget()
                                    throws WTException

Throws:

WTException

getCookie

protected ServletSessionCookie getCookie(String cookieName)