Package com.ptc.windchill.enterprise.change2.forms.processors

Class CreateChangeNoticeFormProcessor

java.lang.Object

com.ptc.core.components.forms.DefaultObjectFormProcessor

com.ptc.core.components.forms.CreateObjectFormProcessor

com.ptc.windchill.enterprise.change2.forms.processors.CreateChangeItemFormProcessor

com.ptc.windchill.enterprise.change2.forms.processors.CreateChangeNoticeFormProcessor

All Implemented Interfaces:

ObjectFormProcessor, com.ptc.windchill.enterprise.change2.forms.processors.ChangeFormProcessor

Direct Known Subclasses:

CreateChangeNoticeTemplateFormProcessor

public class CreateChangeNoticeFormProcessor
extends CreateChangeItemFormProcessor

A class for top-level processor that perform a database operation on one or more change notice objects.

Implementation Notes: The association of the Change Impact Matrix is supported at this release, however in the future this functionality may be replaced by change templates. The association of the Change Impact Matrix will only take place if the property com.ptc.windchill.pdmlink.change.ImpactMatrix is set to true in the wt.properties file. The used to associate to the change notice is declared with the property com.ptc.windchill.pdmlink.change.changeImpactMatrixFile in wt.properties. The default value is /com/ptc/windchill/pdmlink/change/client/CMIIChangeImpactMatrix.xls . This value must be specified as a relative web-resource file path under the $WT_HOME/codebase location. If an exception occurs associating the Change Impact Matrix to the change notice, the processing of the change notice will not be terminated or rolled back. Any errors that occur will be logged in the Method Server log files.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.core.components.forms.DefaultObjectFormProcessor

delegates, DO_OPERATION, overallResult, POST_PROCESS, POST_TRANSACTION_PROCESS, PRE_PROCESS

Method Summary

Modifier and Type	Method	Description
FormResult	postTransactionProcess(NmCommandBean clientData, List<ObjectBean> objectBeans)	The post-transaction process is invoked after the change notices have been successfully persisted.
FormResult	preProcess(NmCommandBean clientData, List<ObjectBean> objectBeans)	This method will create the object that processor delegates will use Supported API: true
protected WTList	saveChangeItem(WTList changeItems)	The purpose of this method is to handle persistance for Change Notices.

Methods inherited from class com.ptc.windchill.enterprise.change2.forms.processors.CreateChangeItemFormProcessor

doOperation, getLocale, postProcess, saveChangeItem, setRefreshInfo

Methods inherited from class com.ptc.core.components.forms.CreateObjectFormProcessor

createAndValidateTypeInstance, createItemInstance, createPersistable, getSuccessMessageBody, getSuccessMessageBodyForMulti, getSuccessMessageTitle, translateTIToPersistable

Methods inherited from class com.ptc.core.components.forms.DefaultObjectFormProcessor

continueProcessing, execute, getDelegates, getSuccessFeedbackMessage, getSuccessFeedbackMessage, isUseObjectReference, mergeIntermediateResult, processDelegates, removeTempFiles, setDelegates, setResultNextAction, setUseObjectReference

Methods inherited from class java.lang.Object

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

Method Details

preProcess

public FormResult preProcess(NmCommandBean clientData,
 List<ObjectBean> objectBeans)
                      throws WTException

This method will create the object that processor delegates will use

Supported API: true

Specified by:

preProcess in interface ObjectFormProcessor

Overrides:

preProcess in class CreateObjectFormProcessor

Parameters:

clientData - Passes in the NmCommandBean

objectBeans - Passes in the List of object beans.

Returns:

FormResult Return the status of the preProcess operation.

Throws:

WTException

postTransactionProcess

public FormResult postTransactionProcess(NmCommandBean clientData,
 List<ObjectBean> objectBeans)
                                  throws WTException

The post-transaction process is invoked after the change notices have been successfully persisted. Any additional processing (such as the association of the Change Impact Matrix) will occur at this point.

Supported API: true

Specified by:

postTransactionProcess in interface ObjectFormProcessor

Overrides:

postTransactionProcess in class DefaultObjectFormProcessor

Parameters:

clientData - The client data used for the processing

objectBeans - The list of Objects being processed.

Returns:

FormResult - the result of this method

Throws:

WTException

saveChangeItem

protected WTList saveChangeItem(WTList changeItems)
                         throws WTException

The purpose of this method is to handle persistance for Change Notices. All Change Notices in the list that is passed in are of the same type. The order of the list needs to be maintained and return in the same order as a list of persisted change Notices.

Supported API: true

Specified by:

saveChangeItem in class CreateChangeItemFormProcessor

Parameters:

changeItems - The list of Change Notices to be persisted.

Returns:

The list of Change Notices that have been persisted.

Throws:

WTException - is thrown if saving the Change Notices fails.

See Also:

• ChangeService2.saveChangeOrder(ChangeOrderIfc)