Package com.ptc.core.components.forms
Class DefaultEditFormProcessor
java.lang.Object
com.ptc.core.components.forms.DefaultObjectFormProcessor
com.ptc.core.components.forms.DefaultEditFormProcessor
- All Implemented Interfaces:
ObjectFormProcessor
- Direct Known Subclasses:
CreateCapaEffectivenessFormProcessor,EditCapaChangeInvestigationFormProcessor,EditCEDecontaminationFormProcessor,EditCEProductInvestigationFormProcessor,EditCEReviewFormProcessor,EditChangeDirectiveFormProcessor,EditChangeItemFormProcessor,EditDispositionPlanFormProcessor,EditDistributionTargetFormProcessor,EditMeetingFormProcessor,EditProfileFormProcessor,EditQMSContactFormProcessor,EditRRDSubmissionFormProcessor,EditRuleFormProcessor,EditSharedTeamFormProcessor,EditStructureCapaChangeActivityFormProcessor,EditUDIPackagingFormProcessor,EditWorkableFormProcessor,PerformDispositionFormProcessor
A form processor that generically updates one or more Persistables in the database from the form data submitted in an
HTML wizard.
This class should only be used for updating nonWorkable objects. Use
Supported API: true
Extendable: true
This class should only be used for updating nonWorkable objects. Use
EditWorkableFormProcessor for Workable
objects.
Supported API: true
Extendable: true
-
Method Summary
Modifier and TypeMethodDescriptiondoOperation(NmCommandBean clientData, List<ObjectBean> objectBeans) Updates the objects contained in the "object" attributes of the given ObjectBean(s) in the database.preProcess(NmCommandBean clientData, List<ObjectBean> objectBeans) Retrieves the objects being edited from the database and updates or sets their attributes from the form data.Methods inherited from class com.ptc.core.components.forms.DefaultObjectFormProcessor
continueProcessing, getDelegates, getSuccessFeedbackMessage, getSuccessFeedbackMessage, getSuccessMessageBody, getSuccessMessageBodyForMulti, getSuccessMessageTitle, mergeIntermediateResult, postProcess, postTransactionProcess, processDelegates, setResultNextAction
-
Method Details
-
doOperation
public FormResult doOperation(NmCommandBean clientData, List<ObjectBean> objectBeans) throws WTException Updates the objects contained in the "object" attributes of the given ObjectBean(s) in the database. On entry, the attributes of these object instances will reflect the values entered in the wizard form.
This method is called by the DefaultFormProcessorController after it calls the preProcess() method.
Before storing the object(s), this method calls the doOperation() method of all ObjectFormProcessorDelegates for the wizard. These are called in no particular order.
Supported API: true- Specified by:
doOperationin interfaceObjectFormProcessor- Overrides:
doOperationin classDefaultObjectFormProcessor- Parameters:
clientData- - Contains all the request form data and other wizard context information. Input. Required.objectBeans- The "object" attribute of these beans contain the object instances to be updated. One bean per object. Input. Required.- Returns:
- FormResult - the result of this method
- Throws:
WTException
-
preProcess
public FormResult preProcess(NmCommandBean clientData, List<ObjectBean> objectBeans) throws WTException Retrieves the objects being edited from the database and updates or sets their attributes from the form data. On exit, instances of the edited objects updated with the form values will be loaded into the "object" attribute of the given ObjectBean(s).
After updating the ObjectBeans, calls the preProcess() method of all ObjectFormProcessorDelegates for the wizard.
This method is called by the DefaultFormProcessorController and is the first wizard processing phase.
For wizards that have a Set Attributes step, this method is also called after the user completes that step to validate the user-entered attribute values. Therefore, this method should not perform any tasks that modify the database.
Supported API: true- Specified by:
preProcessin interfaceObjectFormProcessor- Overrides:
preProcessin classDefaultObjectFormProcessor- Parameters:
clientData- - Contains all the request form data and other wizard context information. Input. Required.objectBeans- - On input, contain the form data for each object being edited. One bean per object. On exit, the "object" attribute of each ObjectBean is set to the object instance created from the form data. Input and output. Required.- Returns:
- - FormResult indicating the outcome of this method
- Throws:
WTException
-