wt.doc
Class WTDocumentProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.change2.htmlclient.ChangeManagementFormProcessor
                  wt.change2.htmlclient.DefaultChangeTaskProcessor
                      wt.doc.WTDocumentProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class WTDocumentProcessor

extends DefaultChangeTaskProcessor

implements Externalizable

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. HTML processing associated with the new Local File Handling imbedded in an applet on the HTML page.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	ALTKEY_PARAMETER Deprecated.
private static String	ATTRIBUTE Deprecated.
private static String	CLASSNAME Deprecated.
private static String	CODEBASE Deprecated.
private FormatContentHolder	contentHolder Deprecated.
protected static boolean	DEBUG Deprecated.
private static String	DEFAULTPATH Deprecated.
private static String	DELIM Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private static String	FORMAT Deprecated.
static String	IMG_PARAMETER Deprecated.
private static String	LASTUPDATED Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private static String	ORG_STACK_NAME Deprecated.
private static String	PRIMARY Deprecated.
private static String	RECORD_DELIM Deprecated.
private static String	RESOURCE Deprecated.
static String	RESOURCECLASS_PARAMETER Deprecated.
static String	RESOURCEKEY_PARAMETER Deprecated.
protected static String	RESULTS_WINDOW Deprecated.
private static ReferenceFactory	RF Deprecated.
private static String	SECONDARY_EXCLUDE Deprecated.
(package private) static long	serialVersionUID Deprecated.
static boolean	SHOW_ORG_ID Deprecated.
private static String	SIZE Deprecated.
protected static String	STRUCT_WINDOW Deprecated.
private static String	TARGETTYPE Deprecated.
private static String	TEMPLATE_FIELDNAME Deprecated.
private static String	TEMPLATE_RESOURCE Deprecated.
protected static boolean	VERBOSE Deprecated.

Fields inherited from class wt.change2.htmlclient.DefaultChangeTaskProcessor

ANALYSIS_ACTIVITY_SECTION_ACTION, ASSOCIATED_WF_PROCESS_ACTION, CHANGE_ACTIVITY_SECTION_ACTION, CHANGE_MANAGEMENT_CREATE_URL_ACTION, CHANGE_OBJECT_CREATE_ACTION, CHANGE_OBJECT_DELETE_ACTION, CHANGE_OBJECT_UPDATE_ACTION, CHANGE_OBJECT_VIEW_ACTION, CLASS_PARAMETER, COLLAPSE_GIF, CREATE_CLASS, CREATE_PARENT, EFFECTIVITY_ACTION, ERROR_MESSAGE, EXPAND, EXPAND_GIF, INVESTIGATE_SECTION_ACTION, LOCATION_OVERRIDE, LOCATION_OVERRIDE_USEDEFAULT, ORDER_SECTION_ACTION, PROPOSE_SECTION_ACTION, SUBMIT_ACTION, TOGGLE, UPDATE, UPDATE_TASK_ACTION, VIEW_EFFECTIVITY_ACTION

Fields inherited from class wt.change2.htmlclient.ChangeManagementFormProcessor

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

CLASS, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR

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

WTDocumentProcessor()
Deprecated.

Method Summary

void	chooseOrganization(Properties parameters, Locale locale, OutputStream os) Deprecated. Displays the organization chooser section of the page, if applicable.
void	contextualValue(Properties parameters, Locale locale, OutputStream os) Deprecated. This call is used to output the value of the attribute identified by the property "propertyName" in the parameters argument.
private void	createTable(Vector blVector, Vector osoVector, int initial_size, Locale locale, OutputStream os) Deprecated.
void	dependencyTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
private String	disabledField(String propertyName, String propertyValue, Properties parameters, Locale locale) Deprecated.
void	displayDocumentIdentity(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	displayFileMessage(Properties parameters, Locale locale, OutputStream os) Deprecated.
private static String	displayIcon(ContentItem contentitem) Deprecated.
private boolean	duplicateDocument(Vector results_vector, WTDocumentMaster current) Deprecated.
void	enumeratedTypeMenuTemplateDefault(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	escapeSymbol(String s) Deprecated.
void	getAppletAttachments(Properties props, Locale locale, OutputStream os) Deprecated.
void	getAppletLocaleParamString(Properties params, Locale locale, OutputStream os) Deprecated.
void	getAttachDependencyLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getAttachFileLink(Properties parameters, Locale locale, OutputStream os) Deprecated. from GSO secondary content customization (Windchill Script method) Returns URLs for Add File, Add URL and Replace buttons on Secondary Content html pages
void	getAttachStructureLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getCallingAction(Properties params, Locale locale, OutputStream os) Deprecated.
void	getCheckboxValue(Properties params, Locale locale, OutputStream os) Deprecated.
void	getCheckInFailureLink(Properties params, Locale locale, OutputStream os) Deprecated.
protected Class	getClassParameter(String parameterName, Properties parameters, boolean required) Deprecated. Utility method to obtain a class parameter from the passed Properties object.
FormatContentHolder	getContentHolder() Deprecated.
void	getContextClassName(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getDebug(Properties params, Locale locale, OutputStream os) Deprecated.
void	getDefaultPath(Properties params, Locale locale, OutputStream os) Deprecated. Retrieves a default path for use by the file locator.
void	getDelim(Properties params, Locale locale, OutputStream os) Deprecated.
void	getDnDAppletTags(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getDocumentIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. from GSO secondary content customization (Windchill Script method) Returns the path to the generic content file icon
private String	getDocumentIdentity(FormatContentHolder document, Locale locale) Deprecated.
void	getDownloadRoutingURL(Properties params, Locale locale, OutputStream os) Deprecated.
void	getEnabledValue(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	getFileBrowseTags(Properties parameters, Locale locale, OutputStream os, boolean useApplet) Deprecated.
private String	getFileSize(ApplicationData file) Deprecated. Returns a String containing the size of the given file in Kilobytes.
protected void	getFormat(Properties params, Locale locale, OutputStream os) Deprecated.
void	getGenericProcessorURL(Properties parameters, Locale locale, OutputStream os) Deprecated. To call this method from an html template use a call like the following: useProcessorService service=wt.doc.WTDocumentProcessor method=getGenericProcessorURL action=Delete gateway_method=processForm Method constructs the URL for a generic form action: "http:///../wt.enterprise.URLProcessor/?action=&oid="
protected String	getImage(String imgSrc, String align, String alt, String border) Deprecated. Utility method to return a String containing the HTML to insert an image.
protected String	getImageWithLocalizedAlt(Properties parameters, Locale locale, Class resourceClass) Deprecated.
protected void	getLastUpdated(Properties params, Locale locale, OutputStream os) Deprecated.
private Templateable	getLatestVersionIteration(Templateable obj) Deprecated.
void	getMessageURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
private String	getOIDString(ContentItem contentitem) Deprecated.
private String[][]	getOrganizationSelections(String propertyName) Deprecated.
void	getPreferenceValue(Properties params, Locale locale, OutputStream os) Deprecated.
protected void	getPrimary(Properties params, Locale locale, OutputStream os) Deprecated.
protected String	getPrimary(String purpose) Deprecated.
void	getPrimaryAttribute(Properties params, Locale locale, OutputStream os) Deprecated.
void	getRecordDelim(Properties params, Locale locale, OutputStream os) Deprecated.
protected String	getResourceKeyParameter(String parameterName, Properties parameters, boolean required, Class resourceClass) Deprecated. Utility method to return a String parameter from the passed Properties object.
void	getSecondaryContent(Properties parameters, Locale locale, OutputStream os) Deprecated. from GSO secondary content customization (Windchill Script method) Returns a string of Secondary content files & URLs, separated by semi-colons.
void	getSecondaryFileBrowseTags(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected void	getSize(Properties params, Locale locale, OutputStream os) Deprecated.
protected String	getStringParameter(String parameterName, Properties parameters, boolean required) Deprecated. Utility method to return a String parameter from the passed Properties object.
protected void	getTargetType(Properties params, Locale locale, OutputStream os) Deprecated.
void	getTemplateInput(Properties parameters, Locale locale, OutputStream os) Deprecated. Provide the drop down list that the user can use to select a template.
void	getUrlIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. from GSO secondary content customization (Windchill Script method) Returns the path to the URL link icon
void	getURLTabLink(Properties params, Locale locale, OutputStream os) Deprecated.
void	listLcsTemplateDefault(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	listTeamsTemplateDefault(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	orgChooser(Properties parameters, Locale locale, OutputStream os) Deprecated. Displays an HTML SELECT component for the selection of an organization.
void	orgDependentField(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs an input field for 'propertyName' (propertyName=Number by default), that depends on the specification of an organization, 'orgPropertyName' (orgPropertyName=Organization by default) such that the field for 'propertyName' is enabled (as a text input) only if auto-numbering for the target object type is disabled with respect to the specified organization, and disabled (as a hidden field with a string label) otherwise.
private static String[]	parseIntoArray(String parseFrom, String delimiter, int arraySize) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WTDocumentProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
private float	roundToTwoDecimals(float number) Deprecated. Returns the given float rounded to two decimal places.
void	setContentHolder(FormatContentHolder contentHolder) Deprecated.
private Vector	setTableValues(Vector results_vector, String oids, Properties formData, boolean checkbox, String checkbox_name) Deprecated.
private Vector	setTableValues(Vector results_vector, String oids, String comments, Properties formData, boolean checkbox, String checkbox_name, String comment_name) Deprecated.
private Vector	setTableValues(Vector bin_link, Vector oth_side, String oids, String comments, Properties formData, boolean checkbox, String checkbox_name, String comment_name) Deprecated.
private Vector	setTableValuesFromQuery(Vector results_vector, WTDocument parent, Properties formData) Deprecated.
private String	stripCommentsDelimiter(String origComments) Deprecated.
private String	stripCommentsDelimiter(String origComments, String delimiter) Deprecated.
void	structureTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	templateContextualValue(Properties parameters, Locale locale, OutputStream os) Deprecated.
private String	textElement(String sPath) Deprecated. from GSO secondary content customization replaces single backslash with double backslash for display in an HTML text field
private String	textField(String propertyName, String propertyValue, Properties parameters, Locale locale) Deprecated.
void	updateDependencyTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	updateStructureTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.
private void	writeOrgs(String[][] orgs) Deprecated.

Methods inherited from class wt.change2.htmlclient.DefaultChangeTaskProcessor

checkNoCurrentAuthorMode, checkObjectCreateAccess, contextualLocation, createShareStatusTable, displayAnalysisActivitySection, displayChangeActivitySection, displayChangeInvestigationSection, displayChangeOrderSection, displayChangeProposalSection, displayChangeRequestSection, displayCreateNewObject, displayLocationField, getAcceptLink, getAddChangeablesLink, getAddEffectivityLink, getAddToProjectLink, getCancelLink, getContextActionLink, getContextOid, getCopyLink, getCreateParent, getCurrentContextString, getDateWithoutTime, getDeleteLink, getESIChangeLink, getForumLink, getHiddenFieldHTML, getJavascriptNewObjectLink, getLocalizedStringFromParameters, getNewObjectLink, getNewWindowActionLink, getScrollToAnchor, getSignatureLink, getStateLink, getSubmitCheckBox, getSubmitCheckBox, getSubmitLink, getSubmitLink, getSubscriptionLink, getTaskDelegateLink, getUpdateLink, getViewEffectivityLink, initializeContext, initiateExpandableTable, initiateSection, outputHiddenField, readVersion, setContextObjToChangeInvestigation, setHtmlClientState, showErrorMessages, updateChangeAttachmentsTable

Methods inherited from class wt.change2.htmlclient.ChangeManagementFormProcessor

createFormConstruct, displayChangeTask, pageTitle, readVersion

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContextualValue, getEnumeratedTypeMenu, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getObjectIdentity, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getWTContainerRef, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readVersion, selectFolderMenu, selectFolderMenuForContainers

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

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

RESOURCECLASS_PARAMETER

public static final String RESOURCECLASS_PARAMETER

Deprecated.

See Also:

Constant Field Values

RESOURCEKEY_PARAMETER

public static final String RESOURCEKEY_PARAMETER

Deprecated.

See Also:

Constant Field Values

RESULTS_WINDOW

protected static final String RESULTS_WINDOW

Deprecated.

See Also:

Constant Field Values

STRUCT_WINDOW

protected static final String STRUCT_WINDOW

Deprecated.

See Also:

Constant Field Values

TEMPLATE_RESOURCE

private static final String TEMPLATE_RESOURCE

Deprecated.

See Also:

Constant Field Values

contentHolder

private FormatContentHolder contentHolder

Deprecated.

CODEBASE

private static String CODEBASE

Deprecated.

ATTRIBUTE

private static String ATTRIBUTE

Deprecated.

PRIMARY

private static String PRIMARY

Deprecated.

LASTUPDATED

private static String LASTUPDATED

Deprecated.

FORMAT

private static String FORMAT

Deprecated.

SIZE

private static String SIZE

Deprecated.

TARGETTYPE

private static String TARGETTYPE

Deprecated.

DEFAULTPATH

private static String DEFAULTPATH

Deprecated.

IMG_PARAMETER

public static final String IMG_PARAMETER

Deprecated.

See Also:

Constant Field Values

ALTKEY_PARAMETER

public static final String ALTKEY_PARAMETER

Deprecated.

See Also:

Constant Field Values

TEMPLATE_FIELDNAME

private static final String TEMPLATE_FIELDNAME

Deprecated.

See Also:

Constant Field Values

SHOW_ORG_ID

public static final boolean SHOW_ORG_ID

Deprecated.

ORG_STACK_NAME

private static final String ORG_STACK_NAME

Deprecated.

RF

private static final ReferenceFactory RF

Deprecated.

SECONDARY_EXCLUDE

private static String SECONDARY_EXCLUDE

Deprecated.

DELIM

private static String DELIM

Deprecated.

RECORD_DELIM

private static String RECORD_DELIM

Deprecated.

VERBOSE

protected static boolean VERBOSE

Deprecated.

DEBUG

protected static boolean DEBUG

Deprecated.

Constructor Detail

WTDocumentProcessor

public WTDocumentProcessor()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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 DefaultChangeTaskProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

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 DefaultChangeTaskProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTDocumentProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Deprecated.

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

Deprecated.

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

getAttachDependencyLink

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

Deprecated.

(Windchill Script method) Insert a "Add Depends On" WTDocument link ,if appropriate, which will call a javascript method openNewWindow, which allows the user to attach WTDocument dependency links.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

getAttachStructureLink

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

Deprecated.

(Windchill Script method) Insert a "Add Uses" WTDocument link ,if appropriate, which will call a javascript method openNewWindow, which allows the user to attach WTDocument structure links.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

dependencyTable

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

Deprecated.

(Windchill Script method) Displays the WTDocuments that were selected to add to the WTDocument as dependency links.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

structureTable

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

Deprecated.

(Windchill Script method) Displays the WTDocuments that were selected to add to the WTDocument as structure links.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

displayDocumentIdentity

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

Deprecated.

(Windchill Script method) Displays the WTDocuments identity for a document that is not persisted.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

updateDependencyTable

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

Deprecated.

(Windchill Script method) Displays the WTDocuments that were selected to add to the WTDocument as dependency links and the ones that are already persisted and may be modified.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

updateStructureTable

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

Deprecated.

(Windchill Script method) Displays the WTDocuments that were selected to add to the WTDocument as structure links and the ones already persisted that may be deleted.

Supported API: false

Parameters:

parameters -

locale -

os -

Throws:

WTException

setTableValues

private Vector setTableValues(Vector results_vector,
                              String oids,
                              String comments,
                              Properties formData,
                              boolean checkbox,
                              String checkbox_name,
                              String comment_name)
                       throws WTException

Deprecated.

Throws:

WTException

setTableValues

private Vector setTableValues(Vector bin_link,
                              Vector oth_side,
                              String oids,
                              String comments,
                              Properties formData,
                              boolean checkbox,
                              String checkbox_name,
                              String comment_name)
                       throws WTException

Deprecated.

Throws:

WTException

setTableValues

private Vector setTableValues(Vector results_vector,
                              String oids,
                              Properties formData,
                              boolean checkbox,
                              String checkbox_name)
                       throws WTException

Deprecated.

Throws:

WTException

duplicateDocument

private boolean duplicateDocument(Vector results_vector,
                                  WTDocumentMaster current)

Deprecated.

setTableValuesFromQuery

private Vector setTableValuesFromQuery(Vector results_vector,
                                       WTDocument parent,
                                       Properties formData)
                                throws WTException

Deprecated.

Throws:

WTException

createTable

private void createTable(Vector blVector,
                         Vector osoVector,
                         int initial_size,
                         Locale locale,
                         OutputStream os)
                  throws WTException

Deprecated.

Throws:

WTException

setContentHolder

public void setContentHolder(FormatContentHolder contentHolder)

Deprecated.

Overrides:

setContentHolder in class GenerateFormProcessor

getContentHolder

public FormatContentHolder getContentHolder()

Deprecated.

Overrides:

getContentHolder in class GenerateFormProcessor

getPrimaryAttribute

public void getPrimaryAttribute(Properties params,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Deprecated.

Overrides:

getPrimaryAttribute in class GenerateFormProcessor

Throws:

WTException

getPrimary

protected void getPrimary(Properties params,
                          Locale locale,
                          OutputStream os)
                   throws WTException,
                          PropertyVetoException

Deprecated.

Overrides:

getPrimary in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getPrimary

protected String getPrimary(String purpose)
                     throws WTException,
                            PropertyVetoException

Deprecated.

Overrides:

getPrimary in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

displayFileMessage

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

Deprecated.

Throws:

WTException

getLastUpdated

protected void getLastUpdated(Properties params,
                              Locale locale,
                              OutputStream os)
                       throws WTException,
                              PropertyVetoException

Deprecated.

Overrides:

getLastUpdated in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getFormat

protected void getFormat(Properties params,
                         Locale locale,
                         OutputStream os)
                  throws WTException,
                         PropertyVetoException

Deprecated.

Overrides:

getFormat in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getSize

protected void getSize(Properties params,
                       Locale locale,
                       OutputStream os)
                throws WTException,
                       PropertyVetoException

Deprecated.

Overrides:

getSize in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getFileSize

private String getFileSize(ApplicationData file)

Deprecated.

Description copied from class: BasicTemplateProcessor

Returns a String containing the size of the given file in Kilobytes. The string returned also contains the units (e.g "100 KB").

Supported API: false

roundToTwoDecimals

private float roundToTwoDecimals(float number)

Deprecated.

Description copied from class: BasicTemplateProcessor

Returns the given float rounded to two decimal places.

Supported API: false

getTargetType

protected void getTargetType(Properties params,
                             Locale locale,
                             OutputStream os)
                      throws WTException,
                             PropertyVetoException

Deprecated.

Overrides:

getTargetType in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getCheckboxValue

public void getCheckboxValue(Properties params,
                             Locale locale,
                             OutputStream os)
                      throws WTException

Deprecated.

Throws:

WTException

getURLTabLink

public void getURLTabLink(Properties params,
                          Locale locale,
                          OutputStream os)
                   throws WTException

Deprecated.

Overrides:

getURLTabLink in class GenerateFormProcessor

Throws:

WTException

getAppletLocaleParamString

public void getAppletLocaleParamString(Properties params,
                                       Locale locale,
                                       OutputStream os)
                                throws WTException

Deprecated.

Throws:

WTException

getSecondaryContent

public void getSecondaryContent(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws WTException,
                                PropertyVetoException,
                                InvocationTargetException,
                                IllegalAccessException

Deprecated.

from GSO secondary content customization (Windchill Script method) Returns a string of Secondary content files & URLs, separated by semi-colons.

Parameters:

parameters -

locale -

os -

Throws:

WTException

PropertyVetoException

InvocationTargetException

IllegalAccessException

getAttachFileLink

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

Deprecated.

from GSO secondary content customization (Windchill Script method) Returns URLs for Add File, Add URL and Replace buttons on Secondary Content html pages

Parameters:

parameters -

locale -

os -

Throws:

WTException

getDocumentIcon

public void getDocumentIcon(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException,
                            PropertyVetoException,
                            InvocationTargetException,
                            IllegalAccessException

Deprecated.

from GSO secondary content customization (Windchill Script method) Returns the path to the generic content file icon

Parameters:

parameters -

locale -

os -

Throws:

WTException

PropertyVetoException

InvocationTargetException

IllegalAccessException

getUrlIcon

public void getUrlIcon(Properties parameters,
                       Locale locale,
                       OutputStream os)
                throws WTException,
                       PropertyVetoException,
                       InvocationTargetException,
                       IllegalAccessException

Deprecated.

from GSO secondary content customization (Windchill Script method) Returns the path to the URL link icon

Parameters:

parameters -

locale -

os -

Throws:

WTException

PropertyVetoException

InvocationTargetException

IllegalAccessException

textElement

private String textElement(String sPath)

Deprecated.

from GSO secondary content customization replaces single backslash with double backslash for display in an HTML text field

getOIDString

private String getOIDString(ContentItem contentitem)

Deprecated.

displayIcon

private static String displayIcon(ContentItem contentitem)
                           throws WTException,
                                  PropertyVetoException,
                                  InvocationTargetException,
                                  IllegalAccessException

Deprecated.

Throws:

WTException

PropertyVetoException

InvocationTargetException

IllegalAccessException

getContextClassName

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

Deprecated.

getMessageURL

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

Deprecated.

Overrides:

getMessageURL in class GenerateFormProcessor

getDocumentIdentity

private String getDocumentIdentity(FormatContentHolder document,
                                   Locale locale)

Deprecated.

getDefaultPath

public void getDefaultPath(Properties params,
                           Locale locale,
                           OutputStream os)
                    throws WTException,
                           PropertyVetoException

Deprecated.

Retrieves a default path for use by the file locator. Returns empty string if the workspacePath preference hasn't been set.

Supported API: false

Overrides:

getDefaultPath in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getPreferenceValue

public void getPreferenceValue(Properties params,
                               Locale locale,
                               OutputStream os)
                        throws WTException,
                               PropertyVetoException

Deprecated.

Overrides:

getPreferenceValue in class GenerateFormProcessor

Throws:

WTException

PropertyVetoException

getDelim

public void getDelim(Properties params,
                     Locale locale,
                     OutputStream os)

Deprecated.

Overrides:

getDelim in class GenerateFormProcessor

getRecordDelim

public void getRecordDelim(Properties params,
                           Locale locale,
                           OutputStream os)

Deprecated.

getDebug

public void getDebug(Properties params,
                     Locale locale,
                     OutputStream os)

Deprecated.

getClassParameter

protected Class getClassParameter(String parameterName,
                                  Properties parameters,
                                  boolean required)
                           throws WTException

Deprecated.

Description copied from class: DefaultChangeTaskProcessor

Utility method to obtain a class parameter from the passed Properties object.

Supported API: true

Overrides:

getClassParameter in class DefaultChangeTaskProcessor

Parameters:

parameterName -

parameters -

required -

Returns:

Class

Throws:

WTException

getStringParameter

protected String getStringParameter(String parameterName,
                                    Properties parameters,
                                    boolean required)
                             throws WTException

Deprecated.

Description copied from class: DefaultChangeTaskProcessor

Utility method to return a String parameter from the passed Properties object.

Supported API: true

Overrides:

getStringParameter in class DefaultChangeTaskProcessor

Parameters:

parameterName -

parameters -

required -

Returns:

String

Throws:

WTException

getResourceKeyParameter

protected String getResourceKeyParameter(String parameterName,
                                         Properties parameters,
                                         boolean required,
                                         Class resourceClass)
                                  throws WTException

Deprecated.

Description copied from class: DefaultChangeTaskProcessor

Utility method to return a String parameter from the passed Properties object.

Supported API: true

Overrides:

getResourceKeyParameter in class DefaultChangeTaskProcessor

Parameters:

parameterName -

parameters -

required -

resourceClass -

Returns:

String

Throws:

WTException

getImageWithLocalizedAlt

protected String getImageWithLocalizedAlt(Properties parameters,
                                          Locale locale,
                                          Class resourceClass)
                                   throws WTException

Deprecated.

Overrides:

getImageWithLocalizedAlt in class DefaultChangeTaskProcessor

Throws:

WTException

getImage

protected String getImage(String imgSrc,
                          String align,
                          String alt,
                          String border)

Deprecated.

Description copied from class: DefaultChangeTaskProcessor

Utility method to return a String containing the HTML to insert an image.

Supported API: true

Overrides:

getImage in class DefaultChangeTaskProcessor

Parameters:

imgSrc -

align -

alt -

border -

Returns:

String

getGenericProcessorURL

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

Deprecated.

To call this method from an html template use a call like the following: useProcessorService service=wt.doc.WTDocumentProcessor method=getGenericProcessorURL action=Delete gateway_method=processForm Method constructs the URL for a generic form action: "http:///../wt.enterprise.URLProcessor/?action=&oid="

Throws:

WTException

getDnDAppletTags

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

Deprecated.

Overrides:

getDnDAppletTags in class GenerateFormProcessor

getFileBrowseTags

public String getFileBrowseTags(Properties parameters,
                                Locale locale,
                                OutputStream os,
                                boolean useApplet)
                         throws WTException,
                                PropertyVetoException,
                                IOException

Deprecated.

Throws:

WTException

PropertyVetoException

IOException

getSecondaryFileBrowseTags

public void getSecondaryFileBrowseTags(Properties parameters,
                                       Locale locale,
                                       OutputStream os)
                                throws WTException,
                                       PropertyVetoException,
                                       IOException

Deprecated.

Throws:

WTException

PropertyVetoException

IOException

stripCommentsDelimiter

private String stripCommentsDelimiter(String origComments)

Deprecated.

stripCommentsDelimiter

private String stripCommentsDelimiter(String origComments,
                                      String delimiter)

Deprecated.

contextualValue

public void contextualValue(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException,
                            InvocationTargetException,
                            IllegalAccessException,
                            ClassNotFoundException,
                            InstantiationException

Deprecated.

Description copied from class: GenerateFormProcessor

This call is used to output the value of the attribute identified by the property "propertyName" in the parameters argument. If this property is found in the form data or query data, that value will be used otherwise the value from the database will be used.

Supported API: true

Overrides:

contextualValue in class ChangeManagementFormProcessor

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

escapeSymbol

public String escapeSymbol(String s)

Deprecated.

Overrides:

escapeSymbol in class ChangeManagementFormProcessor

chooseOrganization

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

Deprecated.

Displays the organization chooser section of the page, if applicable.

orgChooser

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

Deprecated.

Displays an HTML SELECT component for the selection of an organization.

Throws:

WTException

WTPropertyVetoException

orgDependentField

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

Deprecated.

Outputs an input field for 'propertyName' (propertyName=Number by default), that depends on the specification of an organization, 'orgPropertyName' (orgPropertyName=Organization by default) such that the field for 'propertyName' is enabled (as a text input) only if auto-numbering for the target object type is disabled with respect to the specified organization, and disabled (as a hidden field with a string label) otherwise. When disabled, the form field identified by 'propertyName' is guaranteed to be empty, the previous result being stored in a hidden field named "SAVED_" + 'propertyName'. When enabled, the field is set to the default value of any previously saved entry. A resource class and key are required for the 'disabled' text.

Throws:

WTException

disabledField

private String disabledField(String propertyName,
                             String propertyValue,
                             Properties parameters,
                             Locale locale)
                      throws WTException

Deprecated.

Throws:

WTException

textField

private String textField(String propertyName,
                         String propertyValue,
                         Properties parameters,
                         Locale locale)
                  throws WTException

Deprecated.

Throws:

WTException

getOrganizationSelections

private String[][] getOrganizationSelections(String propertyName)
                                      throws WTException

Deprecated.

Throws:

WTException

writeOrgs

private void writeOrgs(String[][] orgs)

Deprecated.

getEnabledValue

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

Deprecated.

Throws:

WTException

getTemplateInput

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

Deprecated.

Provide the drop down list that the user can use to select a template.

Supported API: false

Parameters:

parameters - Input data.

locale - Locale of the client.

os - Where to send the output.

Throws:

WTException

getCallingAction

public void getCallingAction(Properties params,
                             Locale locale,
                             OutputStream os)
                      throws WTException

Deprecated.

Throws:

WTException

getAppletAttachments

public void getAppletAttachments(Properties props,
                                 Locale locale,
                                 OutputStream os)
                          throws WTException

Deprecated.

Throws:

WTException

parseIntoArray

private static String[] parseIntoArray(String parseFrom,
                                       String delimiter,
                                       int arraySize)

Deprecated.

getDownloadRoutingURL

public void getDownloadRoutingURL(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException,
                                  PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getCheckInFailureLink

public void getCheckInFailureLink(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Deprecated.

Throws:

WTException

templateContextualValue

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

Deprecated.

Throws:

WTException

enumeratedTypeMenuTemplateDefault

public void enumeratedTypeMenuTemplateDefault(Properties parameters,
                                              Locale locale,
                                              OutputStream os)
                                       throws WTException,
                                              InvocationTargetException,
                                              IllegalAccessException,
                                              ClassNotFoundException,
                                              InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

listLcsTemplateDefault

public void listLcsTemplateDefault(Properties parameters,
                                   Locale locale,
                                   OutputStream os)
                            throws WTException,
                                   InvocationTargetException,
                                   IllegalAccessException,
                                   ClassNotFoundException,
                                   InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

listTeamsTemplateDefault

public void listTeamsTemplateDefault(Properties parameters,
                                     Locale locale,
                                     OutputStream os)
                              throws WTException,
                                     InvocationTargetException,
                                     IllegalAccessException,
                                     ClassNotFoundException,
                                     InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

getLatestVersionIteration

private Templateable getLatestVersionIteration(Templateable obj)
                                        throws WTException

Deprecated.

Throws:

WTException