wt.enterprise
Class ObjectPropertiesProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.enterprise.ObjectPropertiesProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ObjectPropertiesProcessor

extends BasicTemplateProcessor

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 class provides object properties template processors.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CODEBASE Deprecated.
private String	displayChangeTable Deprecated.
private String	pOID Deprecated.
private static WTProperties	properties Deprecated.
private static String	RESOURCE Deprecated.
private static boolean	VERBOSE 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, serialVersionUID, 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

ObjectPropertiesProcessor()
Deprecated.

Method Summary

void	getOwnerForPersonalCabinet(Properties parameters, Locale locale, OutputStream os) Deprecated.
HTMLTemplate	getTemplate(Vector preferences) Deprecated.
private HTMLTemplate	getTemplate(Vector preferences, String templateName) Deprecated.
void	handleIncludeRequest(Properties params, Locale locale, OutputStream os, Object contextObject, String templateName) Deprecated. Supported API: false
void	handleRequest(HTTPRequest req, HTTPResponse resp) Deprecated.
void	objectChangeAction(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	objectPropertyTR(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected static String	retrieveContextClass(Properties props) Deprecated. Attempt to retrieve a "class" from the given parameters.
void	showSubTemplate(Properties parameters, Locale locale, OutputStream os) 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

properties

private static WTProperties properties

Deprecated.

CODEBASE

private static String CODEBASE

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

displayChangeTable

private String displayChangeTable

Deprecated.

pOID

private String pOID

Deprecated.

Constructor Detail

ObjectPropertiesProcessor

public ObjectPropertiesProcessor()

Deprecated.

A no argument constructor with no side effects.

Supported API: false

Method Detail

handleRequest

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

Deprecated.

This method handles HTTP GET requests to produce an HTML page which describes properties of the contextual object of an ObjectPropertiesProcessor instance.

It is expected that this method will be called via the URLProcessor which would have been invoked via a URL created using an objectActionLink (defined by the BasicTemplateProcessor class) script call within an HTML template file.

The format of the HTML that is output is determined by an HTML template file. The template that is used is chosen from the templates directory based on the class of the contextual object, the locale and the parameters passed to the objectProperties call. The template file is chosen using the ObjectPropertiesTemplateFactory.

Supported API: false

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor, ObjectPropertiesTemplateFactory

retrieveContextClass

protected static String retrieveContextClass(Properties props)

Deprecated.

Attempt to retrieve a "class" from the given parameters.

handleIncludeRequest

public void handleIncludeRequest(Properties params,
                                 Locale locale,
                                 OutputStream os,
                                 Object contextObject,
                                 String templateName)
                          throws WTException

Deprecated.

Supported API: false

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Deprecated.

Return an initialized HTMLTemplate.

Supported API: false

Throws:

WTException

getTemplate

private HTMLTemplate getTemplate(Vector preferences,
                                 String templateName)
                          throws WTException

Deprecated.

Throws:

WTException

objectPropertyTR

public void objectPropertyTR(Properties parameters,
                             Locale locale,
                             OutputStream os)
                      throws IllegalAccessException,
                             InvocationTargetException,
                             WTIntrospectionException,
                             WTException

Deprecated.

Outputs HTML which represents the name and value of a property embedded in HTML table row tags. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectPropertyTR script call in an HTML template file. The format of objectPropertyTR script calls is:

objectPropertyTR propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectPropertyTR propertyName=requester

The format of the HTML that is output is dependent on the type of the property value. No HTML formatting is output.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException

InvocationTargetException

WTIntrospectionException

WTException

objectChangeAction

public void objectChangeAction(Properties parameters,
                               Locale locale,
                               OutputStream os)
                        throws IllegalAccessException,
                               InvocationTargetException,
                               WTIntrospectionException,
                               WTException

Deprecated.

Outputs HTML which represents the name and value of a property embedded in HTML table row tags. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectChangeAction script call in an HTML template file. The format of objectChangeAction script calls is:

objectChangeAction propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectChangeAction propertyName=requester

The format of the HTML that is output is dependent on the type of the property value. No HTML formatting is output.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException

InvocationTargetException

WTIntrospectionException

WTException

showSubTemplate

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

Deprecated.

getOwnerForPersonalCabinet

public void getOwnerForPersonalCabinet(Properties parameters,
                                       Locale locale,
                                       OutputStream os)
                                throws Exception

Deprecated.

Throws:

Exception