Package com.ptc.core.components.forms

Interface ObjectFormProcessorDelegate

All Known Subinterfaces:
PasteVariantSpecDelegateIfc
All Known Implementing Classes:
com.ptc.windchill.enterprise.attachments.forms.AbstractAttachmentsSubFormProcessor, AffectedAndResultingItemsFormDelegate, AffectedDataFormDelegate, AffectedEndItemsFormDelegate, AnnotationsForAffectedDataFormDelegate, ChangeItemFormDelegate, ChangeTaskAffectedItemsFormDelegate, ChangeTaskResultingItemsFormDelegate, DefaultObjectFormProcessorDelegate, ImpactedItemsFormDelegate, ImplementationPlanFormDelegate, LocationPropertyProcessor, ParticipantsFormDelegate, PasteVariantSpecDelegate, PromotionObjectsFormDelegate, PromotionParticipantsFormDelegate, RelatedChangeItemFormDelegate, RelatedProductDataFormDelegate, SecondaryAttachmentsSubFormProcessor
public interface ObjectFormProcessorDelegate
An interface for a class that performs one or more tasks during the processing of a HTML wizard after submittal. ObjectFormProcessorDelegates are called by ObjectFormProcessors during various phases of the processing. They can be called by multiple form processor classes and typically perform tasks that are common to multiple wizards. Examples of tasks performed by delegates are:
  • check out an object after it is created
  • assign a folder location to an object being created
  • set the access control permissions on an object being created

Implementations of this interface should extend DefaultObjectFormProcessorDelegate to obtain default implementations of all methods.

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
      A method called by an ObjectFormProcessor during the doOperation phase of processing.

      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
      A method called by an ObjectFormProcessor during the postProcess phase of processing.

      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
      A method called by an ObjectFormProcessor during the postTransactionProcess phase of processing.

      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> objectList) throws WTException
      A method called by an ObjectFormProcessor during the preProcess phase of processing.

      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