Package org.silverpeas.components.formsonline.model

Class RequestCriteria

java.lang.Object
org.silverpeas.components.formsonline.model.RequestCriteria
public class RequestCriteria extends Object
Class that permits to set request search criteria for FormsOnline services.
Author:
silveryocha

  • Constructor Details

    • RequestCriteria

      public RequestCriteria()

  • Method Details

    • onComponentInstanceIds

      public static RequestCriteria onComponentInstanceIds(String... componentInstanceIds)
      Initializes the criteria with component instance ids.

      By security, if no ids are given, the service using the criteria will return directly an empty list instead of performing the SQL query.

      Parameters:
      componentInstanceIds - identifiers of component instances.
      Returns:
      an instance of criteria.

    • onComponentInstanceIds

      public static RequestCriteria onComponentInstanceIds(Collection<String> componentInstanceIds)
      Initializes the criteria with component instance ids.

      By security, if no ids are given, the service using the criteria will return directly an empty list instead of performing the SQL query.

      Parameters:
      componentInstanceIds - identifiers of component instances.
      Returns:
      an instance of criteria.

    • andIds

      public RequestCriteria andIds(String... ids)
      Configures the criteria of form instance ids.
      Parameters:
      ids - identifiers of form instance.
      Returns:
      an instance of criteria.

    • andIds

      public RequestCriteria andIds(Collection<String> ids)
      Configures the criteria of form instance ids.
      Parameters:
      ids - identifiers of form instance.
      Returns:
      an instance of criteria.

    • andFormIds

      public RequestCriteria andFormIds(String... formIds)
      Configures the criteria of form ids.
      Parameters:
      formIds - identifiers of forms.
      Returns:
      an instance of criteria.

    • andFormIds

      public RequestCriteria andFormIds(Collection<String> formIds)
      Configures the criteria of form ids.
      Parameters:
      formIds - identifiers of forms.
      Returns:
      an instance of criteria.

    • andStates

      public RequestCriteria andStates(Integer... states)
      Configures the criteria of states.
      Parameters:
      states - form states.
      Returns:
      an instance of criteria.

    • andStates

      public RequestCriteria andStates(Collection<Integer> states)
      Configures the criteria of states.
      Parameters:
      states - form states.
      Returns:
      an instance of criteria.

    • andCreatorId

      public RequestCriteria andCreatorId(String creatorId)
      Configures the criteria of creator id.
      Parameters:
      creatorId - identifier of a creator of a form.
      Returns:
      an instance of criteria.

    • andCreatorIds

      public RequestCriteria andCreatorIds(Collection<String> creatorIds)
      Configures the criteria of creator id.
      Parameters:
      creatorIds - creator identifiers of form.
      Returns:
      an instance of criteria.

    • andValidationCriteria

      public RequestCriteria andValidationCriteria(RequestValidationCriteria validationCriteria)
      Configures the validation criteria.
      Parameters:
      validationCriteria - criteria of validation.
      Returns:
      an instance of criteria.

    • orderBy

      public RequestCriteria orderBy(RequestCriteria.QUERY_ORDER_BY... orderBies)
      Configures the order by clause.
      Parameters:
      orderBies - the list of order by directives.
      Returns:
      itself.

    • paginateBy

      public RequestCriteria paginateBy(org.silverpeas.core.admin.PaginationPage pagination)
      Sets the criteria of pagination.
      Parameters:
      pagination - the pagination.
      Returns:
      itself.

    • toString

      public String toString()
      Overrides:
      toString in class Object