Package com.aquima.interactions.framework.container.instance.list.param

Class InstanceListParameters

java.lang.Object
com.aquima.interactions.framework.container.instance.list.param.InstanceListParameters
public final class InstanceListParameters extends Object
This class parses the parameters needed for the instance selector plus container.
Since:
5.0
Author:
Jon van Leuven

  • Method Details

    • getInstance

      public static InstanceListParameters getInstance(IParameters parameters)
      This method converts the parameters object passed to the container to an instance-selector parameters object.
      Parameters:
      parameters - The parameters object that was passed to the container.
      Returns:
      The parameters object for the instance selector.

    • getAddButtons

      public String[] getAddButtons()
      This method returns an array containing the add buttons.
      Returns:
      an array containing the add buttons.

    • getAddButtonEvent

      public String getAddButtonEvent(int buttonIndex)

    • getAddButtonCondition

      public String getAddButtonCondition()
      This method returns the value for the 'add-button-condition' parameter.
      Returns:
      the value for the 'addbuttoncondition' parameter.

    • getHeaderContainer

      public String getHeaderContainer()
      This method returns the name of the container that should be used as header.
      Returns:
      the name of the container that should be used as header.

    • hasHeaderContainer

      public boolean hasHeaderContainer()
      This method returns a boolean indicating if the header container has been specified.
      Returns:
      a boolean indicating if the header container has been specified.

    • getNoInstancesContainer

      public String getNoInstancesContainer()
      This method returns the name of the container that should be used when no instances are available.
      Returns:
      the name of the container that should be used when no instances are available.

    • getEntityName

      public String getEntityName()
      This method returns the name of the entity whose instances should be selected.
      Returns:
      the name of the entity whose instances should be selected.

    • getSortExpression

      public String getSortExpression()
      This method returns the expression that should be used to sort the instances on.
      Returns:
      the attribute name that should be used to sort the instances on.

    • getSortOrder

      public int getSortOrder()
      This method returns an integer indicating the sort order.
      Returns:
      an integer indicating the sort order.

    • getFilterExpression

      public String getFilterExpression()
      This method returns an expression that should be used to check if an instance should be included in the list.
      Returns:
      an expression that should be used to check if an instance should be included in the list.

    • isInstanceActionNowForSave

      public boolean isInstanceActionNowForSave()
      This method returns a boolean indicating if the save action should directly update the instance.
      Returns:
      a boolean indicating if the save action should directly update the instance.

    • getReferrerPath

      public String getReferrerPath()
      This method returns the relation attribute that was used to refer to the container.
      Returns:
      the relation attribute that was used to refer to the container.

    • isSortUnknownAsLast

      public boolean isSortUnknownAsLast()
      This method returns a boolean indicating if the the instances with a sort key that result in unknown must be sorted at the end of the instance list.
      Returns:
      a boolean indicating if unknowns must be sorted at the end of the instance list.

    • getPagingSize

      public IntegerValue getPagingSize()
      An integer value to indicate the desired amount of items on a single page.
      Returns:
      integer value to set the paging size (can be null).