Package com.ptc.jca.mvc.components

Class JcaComponentParams

java.lang.Object
com.ptc.jca.mvc.components.JcaComponentParams
All Implemented Interfaces:
ComponentParams, Serializable, Cloneable
public final class JcaComponentParams extends Object implements ComponentParams, Serializable, Cloneable
JCA implementation of ComponentParams Supported API: true

Extendable: false
See Also:

  • Constructor Details

    • JcaComponentParams

      public JcaComponentParams(NmHelperBean helperBean)


      Supported API: true
      Parameters:
      helperBean -

  • Method Details

    • getHelperBean

      public NmHelperBean getHelperBean()


      Supported API: true
      Returns:

    • getDescriptor

      public ComponentDescriptor getDescriptor()
      Get the descriptor that was build by the JcaComponentConfig for the current request. Try not to use this unless absolutely necessary.

      Supported API: true
      Returns:
      ComponentDescriptor

    • setDescriptor

      public void setDescriptor(ComponentDescriptor descriptor)


      Supported API: true
      Parameters:
      descriptor -

    • setContextObject

      public void setContextObject(Object object)
      Set the contextObject to use for this component
      Note: This should rarely be used. It is mostly for customization scenarios where components for Object B are to be shown on the info page of Object A.
      Be careful when changing the context object, it could have unintended consequences if the context object is changed at the wrong time --- for example, if a builder has already made calculations based on the original context. Also, this API is not expected to work for wizards doing CREATE operations. For CREATE operations the context object is driven by InitializeItemTag and Type Picker. See Wizard customization documentation for more info. Sets both the context object and context object type identifier. Those 2 should almost always be a 'matching' pair representing the same type. In certain edge cases the context object may not be Typed. To set the type identifier separately for those cases see JcaComponentParamsUtils.setContextObjectTypeIdentifier(JcaComponentParams, com.ptc.core.meta.common.TypeIdentifier) Supported API: true
      Parameters:
      object - to use as the context object

    • getOffSet

      public int getOffSet(String componentId)
      offSet information from the request

      Supported API: true
      Parameters:
      componentId -
      Returns:

    • getContainerRef

      public Object getContainerRef()
      Get the container attached to this component

      Supported API: true
      Returns:
      Object

    • getFormat

      public com.ptc.mvc.util.UriFormat getFormat()
      Returns the format looking at
      Accept header, else Request URI, otherwise null if no valid format request was made

      Supported API: true
      Specified by:
      getFormat in interface ComponentParams
      Returns:
      com.ptc.mvc.util.Format

    • getNmCommandBean

      public NmCommandBean getNmCommandBean() throws WTException
      Gets the NmCommandBean object from component params
      Supported API: true
      Returns:
      Throws:
      WTException