com.ptc.core.components.forms
Interface ObjectFormProcessor

All Known Implementing Classes:

AlternatesSubstitutesFormProcessor, CreateChangeItemFormProcessor, CreateChangeRequestFormProcessor, CreateChangeTaskFormProcessor, CreateContextLinkFormProcessor, CreateESITargetFormProcessor, CreateNetworkLinkFormProcessor, CreateObjectFormProcessor, CreatePartConfigurationFormProcessor, CreateProblemReportFormProcessor, CreateScmAdapterFormProcessor, CreateScmAdapterLinkFormProcessor, DefaultEditFormProcessor, com.ptc.core.components.forms.DefaultObjectFormProcessor, EditChangeItemFormProcessor, EditChangeNoticeFormProcessor, EditChangeRequestFormProcessor, EditChangeTaskFormProcessor, com.ptc.core.components.forms.EditObjectFormProcessor, EditProblemReportFormProcessor, EditScmAdapterFormProcessor, EditVarianceFormProcessor, EditWorkableFormProcessor, RelContextSendOwnerNotificationFormProcessor, RepopPartConfigurationFormProcessor, SaveAsPartConfigurationFormProcessor, SendRelContextNotificationFormProcessor, SendToDistributionTargetFormProcessor, UpdateContextLinkFormProcessor

public interface ObjectFormProcessor

An interface for classes that process the data submitted by an HTML wizard. Typically these perform database operation(s) on one or more objects. ObjectFormProcessors may, in turn, call ObjectFormProcessorDelegates to handle tasks common to multiple wizards. For example, a delegate might be used to handle the creation of attachments for multiple wizards.

See the Windchill Customizers' Guide for more information on wizard processing.

Supported API: true

Extendable: false

Method Summary

FormResult	doOperation(NmCommandBean clientData, List<ObjectBean> objectBeans) Do an operation on one or more objects.
FormResult	postProcess(NmCommandBean clientData, List<ObjectBean> objectBeans) Do postprocessing on one or more objects after an operation but within the same database transaction block.
FormResult	postTransactionProcess(NmCommandBean clientData, List<ObjectBean> objectBeans) Do postprocessing on one or more objects after an operation and outside of the operation's transaction block.
FormResult	preProcess(NmCommandBean clientData, List<ObjectBean> objectBeans) Do processing to prepare one or more objects for an operation.
void	setDelegates(List<ObjectFormProcessorDelegate> delegates) Set the list of ObjectFormProcessorDelegates to be called by the processor.
FormResult	setResultNextAction(FormResult result, NmCommandBean clientData, List<ObjectBean> objectBeans) Set the nextAction attribute of the passed FormResult based on the status set in the FormResult.

Method Detail

doOperation

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

Do an operation on one or more objects. Called after the preProcess() method.

Supported API: true

Parameters:

clientData - - Contains all the form data and other context information from the wizard client. Input.

objectBeans - - Each bean contains the form data for one object being operated upon. Input.

Returns:

FormResult - The result of this method.

Throws:

WTException

postProcess

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

Do postprocessing on one or more objects after an operation but within the same database transaction block. Called after the doOperation() method.

Supported API: true

Parameters:

clientData - - Contains all the form data and other context information from the wizard client. Input.

objectBeans - - Each bean contains the form data for one object being operated upon. Input.

Returns:

FormResult - The result of this method.

Throws:

WTException

postTransactionProcess

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

Do postprocessing on one or more objects after an operation and outside of the operation's transaction block. Called after the postProcess() method.

Supported API: true

Parameters:

clientData - - Contains all the form data and other context information from the wizard client. Input.

objectBeans - - Each bean contains the form data for one object being operated upon. Input.

Returns:

FormResult - The result of this method.

Throws:

WTException

preProcess

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

Do processing to prepare one or more objects for an operation. This is the first processing phase.

Supported API: true

Parameters:

clientData - - Contains all the form data and other context information from the wizard client. Input.

objectBeans - - Each bean contains the form data for one object being operated upon. Input.

Returns:

FormResult - The result of this method.

Throws:

WTException

setDelegates

void setDelegates(List<ObjectFormProcessorDelegate> delegates)

Set the list of ObjectFormProcessorDelegates to be called by the processor.

Supported API: true

Parameters:

delegates -

setResultNextAction

FormResult setResultNextAction(FormResult result,
                               NmCommandBean clientData,
                               List<ObjectBean> objectBeans)
                               throws WTException

Set the nextAction attribute of the passed FormResult based on the status set in the FormResult.

Supported API: true

Parameters:

result - - the FormResult to set. Input and output.

clientData - - Contains all the form data and other context information from the wizard client. Input.

objectBeans - - Each bean contains the form data for one object being operated upon. Input.

Returns:

FormResult with nextAction set

Throws:

WTException