Package com.ptc.core.components.beans

Class CreateAndEditWizBean

java.lang.Object
com.ptc.core.components.beans.CreateAndEditWizBean
All Implemented Interfaces:
Serializable, RemoteAccess
public class CreateAndEditWizBean extends Object implements Serializable, RemoteAccess
This class is used to set and retrieve information needed by an instance of an object creation or edit wizard. This information includes:

  • wizard input parameters, such as type of operation and AttributePopulator class
  • parameters derived from the launch context of the wizard, such as default container and object base type
  • internal variables used for displaying and processing the wizard, such as selected object type and selected container

If the wizard operates on multiple objects, the data specific to a given object will be identified by attaching an "object handle" string to the parameter key. Data common to all objects and data in a wizard that operates on a single object will have no associated object handle (the object handle will be an empty string).

This information is used by:

  • Step jsps, which retrieve the data using the non-static getters on the instance of the bean associated with the jsp page. These getters will retrieve the data for the current object by retrieving the current object handle stored in the HTTPServletRequest attributes (preloaded steps) or HTTPServletRequest parameters (nonpreloaded steps). (Note that steps marked 'preloadWizardPage="false"' in actions.xml will behave as if they were preloaded if they are the first step in the wizard.)
  • The classes that acquire the data model used to display panels and tables in the wizard. These classes should retrieve the current object's handle from the NmCommandBean's HTTPRequestData parameter map via a call to the static getCurrentObjectHandle(FormDataHolder) method. They should then request data by calling the static getter that takes this objectHandle and a NmCommandBean.
  • The renderers for input fields, which will retrieve the current object handle from the bean and attach it to the name attribute of each input field.
  • The form processing classes which process the wizard data when the wizard is submitted. The FormProcessorController processing classes will partition the form data by object handle and hand it off to ObjectFormProcessors in ObjectBeans. The parameter keys in ObjectBeans will not have object handles so the ObjectFormProcessors should retrieve the data by calling the static getter with a null object handle and an ObjectBean.




    • Supported API: true

    Extendable: false
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CREATE
    Value that should be passed to the InitializeItemTag for an object creation wizard

    Supported API: true
    static final String
    CREATE_SKIP_OIRS
    Use this value when creating a Type Instance and you don't want the OIR constraints to be applied to the Type Instance at that time.
    static final String
    EDIT
    Value that should be passed to the InitializeItemTag for an object edit wizard

    Supported API: true

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFormProcessorDelegateConstant()
    Returns the name that should be used for a hidden form field that registers a FormProcessorDelegate for the wizard

    Supported API: true

    Methods inherited from class java.lang.Object

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

  • Field Details

    • CREATE

      public static final String CREATE
      Value that should be passed to the InitializeItemTag for an object creation wizard

      Supported API: true

    • CREATE_SKIP_OIRS

      public static final String CREATE_SKIP_OIRS
      Use this value when creating a Type Instance and you don't want the OIR constraints to be applied to the Type Instance at that time.

      This is generally used when we create a Type Instance for the attributes in the FORM, then we'll apply the FORM values to the Type Instance. After the FORM values have been applied to the Type Instance, then we'll apply the OIR constraints in case there is a attribute with a ServerPreGen value constraint and there is no value for the attribute in the FORM.

      See Also:
      • CreateEditFormProcessorHelper.getTypeInstanceWithFormVals()

        Supported API: true

    • EDIT

      public static final String EDIT
      Value that should be passed to the InitializeItemTag for an object edit wizard

      Supported API: true

  • Method Details

    • getFormProcessorDelegateConstant

      public String getFormProcessorDelegateConstant()
      Returns the name that should be used for a hidden form field that registers a FormProcessorDelegate for the wizard

      Supported API: true