wt.change2.htmlclient
Class ChangeInvestigationProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.change2.htmlclient.ChangeManagementFormProcessor
                  wt.change2.htmlclient.DefaultChangeTaskProcessor
                      wt.change2.htmlclient.ChangeAnalysisProcessor
                          wt.change2.htmlclient.ChangeInvestigationProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Deprecated. 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 on a JSP framework in an upcoming release.

public class ChangeInvestigationProcessor

extends ChangeAnalysisProcessor

implements Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private QueryResult	investigationQR Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private static String	RESOURCE Deprecated.
(package private) static long	serialVersionUID Deprecated.

Fields inherited from class wt.change2.htmlclient.DefaultChangeTaskProcessor

ALTKEY_PARAMETER, 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, IMG_PARAMETER, INVESTIGATE_SECTION_ACTION, LOCATION_OVERRIDE, LOCATION_OVERRIDE_USEDEFAULT, ORDER_SECTION_ACTION, PROPOSE_SECTION_ACTION, RESOURCECLASS_PARAMETER, RESOURCEKEY_PARAMETER, RESULTS_WINDOW, SUBMIT_ACTION, TOGGLE, UPDATE, UPDATE_TASK_ACTION, VERBOSE, 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, CODEBASE, 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

ChangeInvestigationProcessor()
Deprecated.

Method Summary

protected boolean	checkAllowNewInvestigation(Class investigationClass) Deprecated.
protected boolean	checkNoExistingInvestigation() Deprecated.
void	displayChangeInvestigationTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	displayCreateNewObject(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getNewInvestigationLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected void	initializeInvestigationQR() 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(ChangeInvestigationProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.

Methods inherited from class wt.change2.htmlclient.ChangeAnalysisProcessor

checkAllowNewAnalysisActivity, displayAnalysisActivityTable, getNewAnalysisActivityLink, readVersion

Methods inherited from class wt.change2.htmlclient.DefaultChangeTaskProcessor

checkNoCurrentAuthorMode, checkObjectCreateAccess, contextualLocation, createShareStatusTable, displayAnalysisActivitySection, displayChangeActivitySection, displayChangeInvestigationSection, displayChangeOrderSection, displayChangeProposalSection, displayChangeRequestSection, displayLocationField, getAcceptLink, getAddChangeablesLink, getAddEffectivityLink, getAddToProjectLink, getCancelLink, getClassParameter, getContextActionLink, getContextOid, getCopyLink, getCreateParent, getCurrentContextString, getDateWithoutTime, getDeleteLink, getESIChangeLink, getForumLink, getHiddenFieldHTML, getImage, getImageWithLocalizedAlt, getJavascriptNewObjectLink, getLocalizedStringFromParameters, getNewObjectLink, getNewWindowActionLink, getResourceKeyParameter, getScrollToAnchor, getSignatureLink, getStateLink, getStringParameter, 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

contextualValue, createFormConstruct, displayChangeTask, escapeSymbol, pageTitle, readVersion

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContentHolder, getContextualValue, getDefaultPath, getDelim, getDnDAppletTags, getEnumeratedTypeMenu, getFormat, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getLastUpdated, getMessageURL, getObjectIdentity, getPreferenceValue, getPrimary, getPrimary, getPrimaryAttribute, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getSize, getTargetType, getURLTabLink, getWTContainerRef, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, handleExceptionTP, handleExceptionTP, handleProcessorException, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

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

investigationQR

private QueryResult investigationQR

Deprecated.

Constructor Detail

ChangeInvestigationProcessor

public ChangeInvestigationProcessor()

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 ChangeAnalysisProcessor

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 ChangeAnalysisProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ChangeInvestigationProcessor 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

displayChangeInvestigationTable

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

Deprecated.

(Windchill Script method) Insert a table of change investigation objects which can be individually expanded to show more detail.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

getNewInvestigationLink

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

Deprecated.

(Windchill Script method) Insert a "New Investigation Link" if appropriate. This method calls checkAllowNewInvestigation to determine if it is appropriate to insert the link.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

checkAllowNewInvestigation

protected boolean checkAllowNewInvestigation(Class investigationClass)
                                      throws WTException

Deprecated.

Utility method to check if creating a new Change Investigation is allowed given the current state of the user interface.

Supported API: true

Parameters:

investigationClass -

Returns:

boolean

Throws:

WTException

initializeInvestigationQR

protected void initializeInvestigationQR()
                                  throws WTException

Deprecated.

Utility method to query for Change Investigation and set a class variable with the resulting Query Result.

Supported API: true

Throws:

WTException

checkNoExistingInvestigation

protected boolean checkNoExistingInvestigation()
                                        throws WTException

Deprecated.

Utility method to check if there are any existing Change Investigation objects.

Supported API: true

Returns:

boolean

Throws:

WTException

displayCreateNewObject

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

Deprecated.

(Windchill Script method) If the "New" link was clicked for the class matching the "class" parameter, this script method will insert a editable form for creating a new object if all conditions are met. This method overrides the method in the parent class. A check is done to verify that a change investigation does not currently exist for the change request. If this is the case a the superclass method is called and a create form is generated and displayed, otherwise this will be skipped. This was implemented to solve the problem of using the back button which redisplayed the create form even though a change investigation exists.

Supported API: true

Overrides:

displayCreateNewObject in class DefaultChangeTaskProcessor

Parameters:

parameters -

locale -

os -

Throws:

WTException