Package com.ptc.mvc.components

Interface ComponentParams

All Known Implementing Classes:
DefaultComponentParams, JcaComponentParams
public interface ComponentParams
Provides you the infrastructure parameters while creating config/data builders
Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getAttribute(String key)
    Get the given attribute if possible

    Supported API: true
    Object
    getContextObject()
    Get the contextObject attached to this component

    Supported API: true
    List<String>
    getDynamicComponentIds()
    This method expects Ids of components which will be updated by an AJAX request.
    com.ptc.mvc.util.UriFormat
    getFormat()
    Returns the format of the requested uri, otherwise null if no valid format request was made

    Supported API: true
    Object
    getParameter(String key)
    Get the given Parameter if possible

    Supported API: true
    WTPrincipal
    getUser()
    Get the current user

    Supported API: true
    boolean
    isDynamic()
    Is the component to be build dynamically?

    Supported API: true
    void
    removeAttribute(String key)
    Remove the given attribute mapping

    Supported API: true
    void
    setAttribute(String key, Object value)
    Set a value for the given attribute

    Supported API: true

  • Method Details

    • getContextObject

      Object getContextObject()
      Get the contextObject attached to this component

      Supported API: true
      Returns:
      Object

    • getAttribute

      Object getAttribute(String key)
      Get the given attribute if possible

      Supported API: true
      Parameters:
      key -
      Returns:
      Object

    • getParameter

      Object getParameter(String key)
      Get the given Parameter if possible

      Supported API: true
      Parameters:
      key -
      Returns:
      Object

    • setAttribute

      void setAttribute(String key, Object value)
      Set a value for the given attribute

      Supported API: true
      Parameters:
      key -
      value -

    • removeAttribute

      void removeAttribute(String key)
      Remove the given attribute mapping

      Supported API: true
      Parameters:
      key - The attribute to remove

    • getUser

      WTPrincipal getUser()
      Get the current user

      Supported API: true

    • getDynamicComponentIds

      List<String> getDynamicComponentIds()
      This method expects Ids of components which will be updated by an AJAX request. Implementation should return the list of ComponentIds to be updated. If this list is empty or null the request will be considered as normal request.

      Supported API: true
      Returns:

    • getFormat

      com.ptc.mvc.util.UriFormat getFormat()
      Returns the format of the requested uri, otherwise null if no valid format request was made

      Supported API: true
      Returns:
      com.ptc.mvc.util.Format

    • isDynamic

      boolean isDynamic()
      Is the component to be build dynamically?

      Supported API: true
      Returns:
      boolean