wt.part
Class BOMTemplateProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.part.BOMTemplateProcessor

All Implemented Interfaces:

ApplicationContextChild, ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

BOMHierarchyTemplateProcessor, BOMPartsListTemplateProcessor

public abstract class BOMTemplateProcessor

extends BasicTemplateProcessor

implements ApplicationContextChild

Deprecation Notice: 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 using a different framework in an upcoming release. This abstract class implements a template processor for generating HTML that displays a Bill of Materials (BOM).

Supported API: false

Extendable: false

See Also:

"'Customizing the HTML Client' in 'Customizer's Guide'", Serialized Form

Field Summary

private ApplicationContext	applicationContext Deprecated.
private ConfigSpec	configSpec Deprecated.
private static String	DEFAULT_VISITOR_SERVICE Deprecated.
private static long	EXPIRATION Deprecated.
private static String	EXPIRATION_KEY Deprecated.
private static String	PROCESSING_TEMPLATE Deprecated.
private static String	RESOURCE Deprecated.
private static String	TEMPLATE Deprecated.
private String	visitorService Deprecated.

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, 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, EXTERNALIZATION_VERSION_UID, 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, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, 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.services.applicationcontext.ApplicationContextChild

APPLICATION_CONTEXT

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

BOMTemplateProcessor()
Deprecated. This method constructs an instance.

Method Summary

abstract void	buildBOM(Properties parameters, Locale locale, OutputStream os) Deprecated. This method generates HTML output for a BOM.
void	displayBOMTitle(Properties parameters, Locale locale, OutputStream os) Deprecated.
ApplicationContext	getApplicationContext() Deprecated. This method returns the application context.
ConfigSpec	getConfigSpec() Deprecated. This method returns the config spec.
protected ServletSessionCookie	getCookie(String cookieName) Deprecated.
HTMLTemplate	getTemplate(Vector preferences) Deprecated. This method creates and initializes an HTMLTemplate object.
protected TextOutputVisitor	getVisitor(Class targetClass, Locale locale, PrintWriter out) Deprecated. This method returns a TextOutputVisitor object to be used to generate HTML.
void	handleRequest(HTTPRequest req, HTTPResponse resp) Deprecated. This method handles HTTP GET requests to generate HTML for a BOM.
void	setApplicationContext(ApplicationContext a_ApplicationContext) Deprecated. This method sets the application context.
void	setConfigSpec() Deprecated. This method sets the config spec.
void	setConfigSpec(ConfigSpec configSpec) Deprecated. This method sets the config spec.
static void	setProcessingTemplateName(String newName) Deprecated.
static void	setResourceName(String newName) Deprecated.
static void	setTemplateName(String newName) Deprecated.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, 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, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, hiddenContextString, 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, readExternal, 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, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPIRATION_KEY

private static final String EXPIRATION_KEY

Deprecated.

See Also:

Constant Field Values

EXPIRATION

private static long EXPIRATION

Deprecated.

RESOURCE

private static String RESOURCE

Deprecated.

TEMPLATE

private static String TEMPLATE

Deprecated.

PROCESSING_TEMPLATE

private static String PROCESSING_TEMPLATE

Deprecated.

DEFAULT_VISITOR_SERVICE

private static final String DEFAULT_VISITOR_SERVICE

Deprecated.

See Also:

Constant Field Values

configSpec

private ConfigSpec configSpec

Deprecated.

applicationContext

private ApplicationContext applicationContext

Deprecated.

visitorService

private String visitorService

Deprecated.

Constructor Detail

BOMTemplateProcessor

public BOMTemplateProcessor()
                     throws WTException

Deprecated.

This method constructs an instance. The application context is set to a default value.

Supported API: true

Throws:

WTException

Method Detail

setConfigSpec

public void setConfigSpec()
                   throws WTPropertyVetoException,
                          WTException

Deprecated.

This method sets the config spec. The default config spec for the user and context object is set.

Supported API: true

Throws:

WTPropertyVetoException

WTException

setConfigSpec

public void setConfigSpec(ConfigSpec configSpec)
                   throws WTPropertyVetoException

Deprecated.

This method sets the config spec.

Supported API: true

Parameters:

configSpec - intance to set

Throws:

WTPropertyVetoException

getConfigSpec

public ConfigSpec getConfigSpec()

Deprecated.

This method returns the config spec.

Supported API: true

Returns:

ConfigSpec

setApplicationContext

public void setApplicationContext(ApplicationContext a_ApplicationContext)
                           throws WTPropertyVetoException

Deprecated.

This method sets the application context.

Supported API: false

Specified by:

setApplicationContext in interface ApplicationContextChild

Parameters:

a_ApplicationContext - context to set

Throws:

WTPropertyVetoException

getApplicationContext

public ApplicationContext getApplicationContext()

Deprecated.

This method returns the application context.

Supported API: false

Specified by:

getApplicationContext in interface ApplicationContextChild

Returns:

application context

getVisitor

protected TextOutputVisitor getVisitor(Class targetClass,
                                       Locale locale,
                                       PrintWriter out)
                                throws WTPropertyVetoException

Deprecated.

This method returns a TextOutputVisitor object to be used to generate HTML. The application context services are used to obtain an instance of the Visitor object based on the context object, target class, and action (from the HTTP request parameters). The service.properties file can be modified to specify the actual class of the object that will be returned.

The locale and output stream are set on the Visitor object.

Supported API: true

Parameters:

targetClass - used to specify the Visitor object

locale - Locale to set on the Visitor object

out - Output stream to set on the Visitor object

Returns:

TextOutputVisitor

Throws:

WTPropertyVetoException

handleRequest

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

Deprecated.

This method handles HTTP GET requests to generate HTML for a BOM. The HTTP request parameters specify a contextual object (root node in a prodcut structure), a config spec, and an action. A template file is created and processed. It is expected that this template file will contain script calls that will invoke methods on descendant objects of this class.

This object is constructed and the handleRequest method is called from within the URLTemplateAction method of the URLProcessor object.

Supported API: false

Specified by:

handleRequest in interface TemplateProcessor

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Deprecated.

This method creates and initializes an HTMLTemplate object.

Supported API: false

Parameters:

preferences - Vector of preferences used to initialize the template.

Throws:

WTException

See Also:

HTMLTemplate

buildBOM

public abstract void buildBOM(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException,
                              WTPropertyVetoException

Deprecated.

This method generates HTML output for a BOM. It is invoked from within an HTML template via a Winchill script call. The context object is assumed to be a "root" node in a product structure.

Supported API: true

Parameters:

parameters - script parameters (not used)

locale - used to generate HTML for a specific Locale

os - OutputStream to write to

Throws:

WTPropertyVetoException

WTException

displayBOMTitle

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

Deprecated.

setTemplateName

public static void setTemplateName(String newName)

Deprecated.

setResourceName

public static void setResourceName(String newName)

Deprecated.

setProcessingTemplateName

public static void setProcessingTemplateName(String newName)

Deprecated.

getCookie

protected ServletSessionCookie getCookie(String cookieName)

Deprecated.