Package com.ptc.core.components.forms

Interface ObjectFormProcessor

All Known Implementing Classes:
AlternatesSubstitutesFormProcessor, CEActivityFormProcessor, ChangeLinkAttributeProcessor, ChangeTaskTemplatedFormProcessor, CheckinObjectFormProcessor, CheckoutObjectFormProcessor, CreateAuditFormProcessor, CreateAuditTemplateFormProcessor, CreateCapaChangeInvestigationFormProcessor, CreateCapaChangeRequestFormProcessor, CreateCapaEffectivenessFormProcessor, CreateCapaReviewFormProcessor, CreateCEDecontaminationFormProcessor, CreateCEProductActivityFormProcessor, CreateCEProductInvestigationFormProcessor, CreateCEReviewFormProcessor, CreateChangeDirectiveFormProcessor, CreateChangeIssueFormProcessor, CreateChangeItemFormProcessor, CreateChangeNoticeFormProcessor, CreateChangeNoticeTemplateFormProcessor, CreateChangeRequestFormProcessor, CreateChangeReviewFormProcessor, CreateChangeTaskFormProcessor, CreateChangeTaskTemplateFormProcessor, CreateComplaintActivityFormProcessor, CreateContextLinkFormProcessor, CreateCustomerExperienceEvaluationFormProcessor, CreateCustomerExperienceFormProcessor, CreateDispositionPlanFormProcessor, CreateDistributionTargetFormProcessor, CreateNCFormProcessor, CreateNCReviewFormProcessor, CreateNetworkLinkFormProcessor, CreateObjectFormProcessor, CreatePartConfigurationFormProcessor, CreatePartFormProcessor, CreatePartFromWorkspaceFormProcessor, CreateProblemReportFormProcessor, CreatePromotionRequestFormProcessor, CreateQMSContactFormProcessor, CreateRRDSubmissionFormProcessor, CreateUDIPackagingFormProcessor, CreateUDISubmissionFormProcessor, CreateUDISubmissionTemplateFormProcessor, DefaultEditFormProcessor, DefaultObjectFormProcessor, DispositionTaskFormProcessor, EditCapaChangeInvestigationFormProcessor, EditCapaChangeRequestFormProcessor, EditCapaChangeRequestFormProcessorQMS, EditCEDecontaminationFormProcessor, EditCEProductInvestigationFormProcessor, EditCEReviewFormProcessor, EditChangeDirectiveFormProcessor, EditChangeIssueFormProcessor, EditChangeItemFormProcessor, EditChangeNoticeFormProcessor, EditChangeNoticeTemplateFormProcessor, EditChangeRequestFormProcessor, EditChangeReviewFormProcessor, EditChangeTaskFormProcessor, EditChangeTaskTemplateFormProcessor, EditCustomerExperienceFormProcessor, EditDispositionPlanFormProcessor, EditDistributionTargetFormProcessor, EditLicenseCountFormProcessor, EditMeetingFormProcessor, EditModifyContentOnlyProcessor, EditNCFormProcessor, EditProblemReportFormProcessor, EditProfileFormProcessor, EditQMSContactFormProcessor, EditReportDistributionFormProcessor, EditRRDSubmissionFormProcessor, EditRuleFormProcessor, EditSharedTeamFormProcessor, EditStructureCapaChangeActivityFormProcessor, EditUDIPackagingFormProcessor, EditVarianceFormProcessor, EditWorkableFormProcessor, ModifyChangeActionStatusFormProcessor, NoRefreshFormProcessor, PerformDispositionFormProcessor, PurgeAuditLogFormProcessor, RelContextSendOwnerNotificationFormProcessor, RepopPartConfigurationFormProcessor, SaveAsPartConfigurationFormProcessor, SaveReportQueryFormProcessor, ScheduleReportFormProcessor, SendRelContextNotificationFormProcessor, SendToDistributionTargetFormProcessor, UDIBulkApprovalFormProcessor, 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 Details

    • 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