wt.part
Class PartOccurrenceProcessor

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

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class PartOccurrenceProcessor

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. Template processor class which displays a hierarchical product structure view for a given part.

Supported API: false

Extendable: false

See Also:

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

Nested Class Summary

class

PartOccurrenceProcessor.Attribute Deprecated. Helper class which maintains information about an attribute.

Field Summary

private PartOccurrenceProcessor.Attribute[]	attributes Deprecated.
private static String	CODEBASE Deprecated.
static String	CODED_NAME Deprecated.
static String	COMBINED_PATH_OCCURRENCE_INDEX Deprecated.
private Vector	combinedPathOccurrences Deprecated.
private boolean	combinedPathOccurrencesAreDone Deprecated.
private ConfigSpec	configSpec Deprecated.
static String	CONTEXT_ACTION Deprecated.
private String	contextAction Deprecated.
static String	DEFAULT_ACTION Deprecated.
private static String	DEFAULT_ATTRIBUTE_LIST Deprecated.
private static String	DEFAULT_PI_VIEW Deprecated.
static String	DEFAULT_TEMPLATE Deprecated.
static String	DISPLAY_SEPARATOR Deprecated.
private boolean	hasOccurrenceInformation Deprecated.
static String	ID_SEPARATOR Deprecated.
static String	LINE_BREAK Deprecated.
static String	LINK_ATTRIBUTE Deprecated.
static String	LIST_SEPARATOR Deprecated.
private static Cache	nodeCache Deprecated.
static String	NULL_STRING Deprecated.
static String	OCCURRENCE Deprecated.
static String	PAGE_ID Deprecated.
private String	pageId Deprecated.
private Properties	params Deprecated.
private Vector	parentsForCombinedPaths Deprecated.
private PartPathOccurrence	pathOccurrence Deprecated.
private WTProduct	pathParent Deprecated.
private Vector	pathsForCombinedPathOccurrences Deprecated.
protected static String	RESOURCE Deprecated.
static String	SINGLE_SEPARATOR Deprecated.
static String	TEMPLATE_PATH Deprecated.
private WTPart	topLevelPart Deprecated.
static boolean	USE_STYLE_SHEET Deprecated.
private WTPartUsageLink	usesLink Deprecated.
private PartUsesOccurrence	usesOccurrence Deprecated.
private WTPart	usesOwner 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, 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_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

PartOccurrenceProcessor()
Deprecated.

Method Summary

protected static Properties	combineParameters(Properties params_to_add, Properties original_params) Deprecated.
void	extractOccurrenceInformation(Properties properties, Locale locale, OutputStream os) Deprecated. Extracts the Occurrence Information from the OCCURRENCE parameter in the URL.
protected PartOccurrenceProcessor.Attribute[]	getAttributeList(String attr_list) Deprecated. Returns an array of Attribute objects corresponding to the given String.
protected PartCombinedPathOccurrence	getCombinedPathOccurrence(int index) Deprecated.
protected Vector	getCombinedPathOccurrences() Deprecated.
protected static String	getContextActionLink(String part_id, String label) Deprecated.
protected PartOccurrenceProcessor.Attribute[]	getDefaultAttributeList() Deprecated. Returns an array of Attribute objects corresponding to the default list of attributes specified in wt.properties.
protected String	getFormEnd() Deprecated. Return the ending tag.
protected String	getFormStart(String name) Deprecated. Output the starting tag.
protected String	getFormStart(String name, String action, String method) Deprecated. Retrieve the starting tag.
protected String	getFormStart(String name, String action, String method, String target) Deprecated. Retrieve the starting tag.
static String	getHiddenFieldHTML(String name, String value) Deprecated.
String	getIcon(Object object) Deprecated.
String	getIcon(WTObject object) Deprecated.
String	getIdentification(Object object, Locale locale) Deprecated.
String	getIdentificationLink(Object object, Locale locale) Deprecated.
static Persistable	getObjectFromReference(String reference) Deprecated. Returns the Persistable which corresponds to the given String object reference.
protected Properties	getParameters(HTTPRequest request) Deprecated. Returns a Properties object containing the parameters received in the given HTTPRequest.
static String	getReferenceStringForPersistable(Persistable obj) Deprecated.
HTMLTemplate	getTemplate(Vector preferences) Deprecated. Method which retrieves the HTML template to be processed by this processor.
protected String	getUniqueId() Deprecated. Returns a String representation of a unique page id.
void	handleRequest(HTTPRequest request, HTTPResponse response) Deprecated. Method invoked when a URL to this template processor is followed.
void	outputCombinedPathOccurrence(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Combined Path Occurrence information.
void	outputCombinedPathOccurrenceData(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Combined Path Occurrence information.
void	outputCombinedPathOccurrenceList(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Combined Path Occurrence information.
protected void	outputContext(PrintWriter out) Deprecated. Method to output the current oid and action in hidden fields.
void	outputGoToPageFunction(PrintWriter out, String name) Deprecated. Outputs the JavaScript function which opens the page corresponding to the given action and the given object.
static void	outputHiddenField(String name, String value, PrintWriter out) Deprecated. Outputs a HIDDEN form field with the given name and given value to the given printwriter.
void	outputOccurrenceHeader(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Path Occurrence information.
void	outputPathOccurrence(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Path Occurrence information.
void	outputPathOccurrenceData(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Path Occurrence information.
void	outputScriptEnd(PrintWriter out) Deprecated. Outputs the closing tag for a scripting section in an HTML page.
void	outputScriptStart(PrintWriter out, String language) Deprecated. Outputs the starting tag for a scripting section in an HTML page.
void	outputSubmitFunction(PrintWriter out, String name) Deprecated. Outputs the JavaScript code to build the function to submit the form.
void	outputUsesOccurrence(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Uses Occurrence information.
void	outputUsesOccurrenceData(Properties properties, Locale locale, OutputStream os) Deprecated. Outputs Uses Occurrence information.
void	setContextObj(Object obj) Deprecated. Sets the context object for this processor.
static void	setDefaultAction(String action) Deprecated.
static void	setDefaultTemplate(String template) Deprecated.
static void	setResource(String resource) Deprecated.
static void	setTemplatePath(String path) Deprecated.
static void	setUseStyleSheet(boolean useStyleSheet) Deprecated.
protected static String	splitString(String string_to_split) Deprecated. Removes the ID_SEPARATOR characters in the given string and replaces them with spaces.

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

topLevelPart

private WTPart topLevelPart

Deprecated.

params

private Properties params

Deprecated.

configSpec

private ConfigSpec configSpec

Deprecated.

pageId

private String pageId

Deprecated.

contextAction

private String contextAction

Deprecated.

attributes

private PartOccurrenceProcessor.Attribute[] attributes

Deprecated.

hasOccurrenceInformation

private boolean hasOccurrenceInformation

Deprecated.

usesOccurrence

private PartUsesOccurrence usesOccurrence

Deprecated.

usesLink

private WTPartUsageLink usesLink

Deprecated.

usesOwner

private WTPart usesOwner

Deprecated.

pathOccurrence

private PartPathOccurrence pathOccurrence

Deprecated.

pathParent

private WTProduct pathParent

Deprecated.

pathsForCombinedPathOccurrences

private Vector pathsForCombinedPathOccurrences

Deprecated.

parentsForCombinedPaths

private Vector parentsForCombinedPaths

Deprecated.

combinedPathOccurrences

private Vector combinedPathOccurrences

Deprecated.

combinedPathOccurrencesAreDone

private boolean combinedPathOccurrencesAreDone

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

CODEBASE

private static String CODEBASE

Deprecated.

DEFAULT_ATTRIBUTE_LIST

private static String DEFAULT_ATTRIBUTE_LIST

Deprecated.

DEFAULT_PI_VIEW

private static String DEFAULT_PI_VIEW

Deprecated.

nodeCache

private static Cache nodeCache

Deprecated.

ID_SEPARATOR

public static final String ID_SEPARATOR

Deprecated.

See Also:

Constant Field Values

DISPLAY_SEPARATOR

public static final String DISPLAY_SEPARATOR

Deprecated.

See Also:

Constant Field Values

SINGLE_SEPARATOR

public static final String SINGLE_SEPARATOR

Deprecated.

See Also:

Constant Field Values

LIST_SEPARATOR

public static final String LIST_SEPARATOR

Deprecated.

See Also:

Constant Field Values

LINK_ATTRIBUTE

public static final String LINK_ATTRIBUTE

Deprecated.

See Also:

Constant Field Values

DEFAULT_ACTION

public static String DEFAULT_ACTION

Deprecated.

DEFAULT_TEMPLATE

public static String DEFAULT_TEMPLATE

Deprecated.

TEMPLATE_PATH

public static String TEMPLATE_PATH

Deprecated.

USE_STYLE_SHEET

public static boolean USE_STYLE_SHEET

Deprecated.

LINE_BREAK

public static final String LINE_BREAK

Deprecated.

See Also:

Constant Field Values

CODED_NAME

public static final String CODED_NAME

Deprecated.

See Also:

Constant Field Values

NULL_STRING

public static final String NULL_STRING

Deprecated.

See Also:

Constant Field Values

PAGE_ID

public static final String PAGE_ID

Deprecated.

See Also:

Constant Field Values

CONTEXT_ACTION

public static final String CONTEXT_ACTION

Deprecated.

See Also:

Constant Field Values

OCCURRENCE

public static final String OCCURRENCE

Deprecated.

See Also:

Constant Field Values

COMBINED_PATH_OCCURRENCE_INDEX

public static final String COMBINED_PATH_OCCURRENCE_INDEX

Deprecated.

See Also:

Constant Field Values

RESOURCE

protected static String RESOURCE

Deprecated.

Constructor Detail

PartOccurrenceProcessor

public PartOccurrenceProcessor()

Deprecated.

Method Detail

handleRequest

public void handleRequest(HTTPRequest request,
                          HTTPResponse response)
                   throws WTException

Deprecated.

Method invoked when a URL to this template processor is followed. This method instantiates an HTML template to be displayed.

Parameters:

request - the HTTPRequest object

response - the HTTPResponse object

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Deprecated.

Method which retrieves the HTML template to be processed by this processor.

Parameters:

preferences - the Vector of preferences used to initialize the HTML template

Returns:

the initialized HTML template processed by this processor

Throws:

WTException

setContextObj

public void setContextObj(Object obj)

Deprecated.

Sets the context object for this processor. This method will set both the context object and the action object to the given object.

Specified by:

setContextObj in interface ContextHolder

Overrides:

setContextObj in class BasicTemplateProcessor

Parameters:

obj -

getFormStart

protected String getFormStart(String name)
                       throws WTException

Deprecated.

Output the starting tag.

Throws:

WTException

getFormStart

protected String getFormStart(String name,
                              String action,
                              String method)

Deprecated.

Retrieve the starting tag. The FORM is named with the given name and the action is set with the given action. The method, if not given, is assumed to be a POST.

Parameters:

name - the name of the form.

action - the action of the form.

method - the method of the form.

getFormStart

protected String getFormStart(String name,
                              String action,
                              String method,
                              String target)

Deprecated.

Retrieve the starting tag. The FORM is named with the given name and the action is set with the given action. The method, if not given, is assumed to be a POST.

Parameters:

name - the name of the form.

action - the action of the form.

method - the method of the form.

getUniqueId

protected String getUniqueId()

Deprecated.

Returns a String representation of a unique page id. The unique page ID is built by combining the session context id and the current time.

Returns:

a String unique page id

getFormEnd

protected String getFormEnd()

Deprecated.

Return the ending tag.

outputContext

protected void outputContext(PrintWriter out)
                      throws WTException

Deprecated.

Method to output the current oid and action in hidden fields. Because this template processor is using a form with a POST, values are not passed on the query string of the URL and need to be passed in hidden fields.

Throws:

WTException

getCombinedPathOccurrence

protected PartCombinedPathOccurrence getCombinedPathOccurrence(int index)

Deprecated.

getCombinedPathOccurrences

protected Vector getCombinedPathOccurrences()
                                     throws WTException

Deprecated.

Throws:

WTException

getContextActionLink

protected static String getContextActionLink(String part_id,
                                             String label)

Deprecated.

outputHiddenField

public static void outputHiddenField(String name,
                                     String value,
                                     PrintWriter out)

Deprecated.

Outputs a HIDDEN form field with the given name and given value to the given printwriter.

Parameters:

name - the Name of the hidden field

value - the value of the hidden field

out - the PrintWriter to write to.

getHiddenFieldHTML

public static String getHiddenFieldHTML(String name,
                                        String value)

Deprecated.

outputGoToPageFunction

public void outputGoToPageFunction(PrintWriter out,
                                   String name)
                            throws WTException

Deprecated.

Outputs the JavaScript function which opens the page corresponding to the given action and the given object. The given name is used as the name of the JavaScript function. If no name is given, "goToPage" is used as the name.

Parameters:

out - the PrintWriter to write the function to.

name - the name of the JavaScript function. If no name is given, 'goToPage' is used.

Throws:

WTException

outputSubmitFunction

public void outputSubmitFunction(PrintWriter out,
                                 String name)

Deprecated.

Outputs the JavaScript code to build the function to submit the form. The function build takes as parameters a string which is set as the value of the hidden field names "context_action". The "context_action" hidden field specifies which node to expand or contract when the form is submitted. The name of the function is given by the given String parameter. If no name is given, the function is defined as "submitForm".

Parameters:

out - the PrintWriter to write to

name - the name of the function

outputScriptStart

public void outputScriptStart(PrintWriter out,
                              String language)

Deprecated.

Outputs the starting tag for a scripting section in an HTML page. The given language string specifies the value of the parameter LANGUAGE in the SCRIPT tag.

Parameters:

out - the PrintWriter to write to.

language - the String language to specify in the script tag

outputScriptEnd

public void outputScriptEnd(PrintWriter out)

Deprecated.

Outputs the closing tag for a scripting section in an HTML page.

Parameters:

out - the PrintWriter to write to.

getParameters

protected Properties getParameters(HTTPRequest request)

Deprecated.

Returns a Properties object containing the parameters received in the given HTTPRequest. This method will get the parameters from the query string of the HTTPRequest, form data of the HTTPRequest, and bizData of the HTTPRequest.

Returns:

the Properties of the HTTPRequest object.

combineParameters

protected static Properties combineParameters(Properties params_to_add,
                                              Properties original_params)

Deprecated.

getObjectFromReference

public static Persistable getObjectFromReference(String reference)
                                          throws WTException

Deprecated.

Returns the Persistable which corresponds to the given String object reference.

Returns:

the Persistable corresponding to the given String reference

Throws:

WTException

outputUsesOccurrence

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

Deprecated.

Outputs Uses Occurrence information. 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

outputUsesOccurrenceData

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

Deprecated.

Outputs Uses Occurrence information. 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

extractOccurrenceInformation

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

Deprecated.

Extracts the Occurrence Information from the OCCURRENCE parameter in the URL. 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

Throws:

WTException

outputOccurrenceHeader

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

Deprecated.

Outputs Path Occurrence information. 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

outputPathOccurrence

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

Deprecated.

Outputs Path Occurrence information. 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

outputPathOccurrenceData

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

Deprecated.

Outputs Path Occurrence information. 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

outputCombinedPathOccurrenceList

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

Deprecated.

Outputs Combined Path Occurrence information. 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

outputCombinedPathOccurrence

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

Deprecated.

Outputs Combined Path Occurrence information. 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

outputCombinedPathOccurrenceData

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

Deprecated.

Outputs Combined Path Occurrence information. 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

splitString

protected static String splitString(String string_to_split)

Deprecated.

Removes the ID_SEPARATOR characters in the given string and replaces them with spaces. This method is useful for allowing arguments with spaces to be passed in to Windchill scripts.

Parameters:

string_to_split - the string to split

Returns:

the given string with spaces replacing the separators

getAttributeList

protected PartOccurrenceProcessor.Attribute[] getAttributeList(String attr_list)

Deprecated.

Returns an array of Attribute objects corresponding to the given String. The given String is parsed and Attribute objects are created for each attribute in the String.

Parameters:

attr_list - a string containing a comma-separated list of attributes

Returns:

an array of Attribute objects corresponding to the given string

getDefaultAttributeList

protected PartOccurrenceProcessor.Attribute[] getDefaultAttributeList()

Deprecated.

Returns an array of Attribute objects corresponding to the default list of attributes specified in wt.properties. This method creates an array of Attribute objects by parsing a string retrieved. from the wt.properties file. The string is the value in wt.properties corresponding to the key given by DEFAULT_ATTRIBUTE_LIST.

Returns:

an array of Attribute objects corresponding to the given string

getIcon

public String getIcon(Object object)

Deprecated.

getIcon

public String getIcon(WTObject object)

Deprecated.

getReferenceStringForPersistable

public static String getReferenceStringForPersistable(Persistable obj)
                                               throws WTException

Deprecated.

Throws:

WTException

getIdentificationLink

public String getIdentificationLink(Object object,
                                    Locale locale)
                             throws WTException

Deprecated.

Throws:

WTException

getIdentification

public String getIdentification(Object object,
                                Locale locale)
                         throws WTException

Deprecated.

Throws:

WTException

setUseStyleSheet

public static void setUseStyleSheet(boolean useStyleSheet)

Deprecated.

setDefaultAction

public static void setDefaultAction(String action)

Deprecated.

setDefaultTemplate

public static void setDefaultTemplate(String template)

Deprecated.

setResource

public static void setResource(String resource)

Deprecated.

setTemplatePath

public static void setTemplatePath(String path)

Deprecated.