Enum QueryParameter

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ORDER_BY
      The oslc.orderBy parameter, that sorts the members using the specified sort keys.
      PAGE_SIZE
      The oslc.pageSize parameter, that specifies a suggested maximum page size for a paged result.
      PAGING
      The oslc.paging parameter, that specifies whether a paged result is requested.
      PREFIX
      The oslc.prefix parameter, that specifies a namespace prefix that may be used in oslc.where, oslc.orderBy, and oslc.select.
      PROPERTIES
      The oslc.properties parameter, that returns a list of properties for an OSLC resource and provides a partial representation of the resource.
      SEARCH_TERMS
      The oslc.searchTerms parameter, that scores each member resource using a full-text search on its text-valued properties, and sorts them in descending order of score.
      SELECT
      The oslc.select parameter, that includes the specified immediate and nested properties of the member resources.
      WHERE
      The oslc.where parameter, that limits the query results to members that satisfy the specified query expression.
    • Enum Constant Detail

      • PREFIX

        public static final QueryParameter PREFIX
        The oslc.prefix parameter, that specifies a namespace prefix that may be used in oslc.where, oslc.orderBy, and oslc.select.
      • WHERE

        public static final QueryParameter WHERE
        The oslc.where parameter, that limits the query results to members that satisfy the specified query expression.
      • SEARCH_TERMS

        public static final QueryParameter SEARCH_TERMS
        The oslc.searchTerms parameter, that scores each member resource using a full-text search on its text-valued properties, and sorts them in descending order of score.
      • ORDER_BY

        public static final QueryParameter ORDER_BY
        The oslc.orderBy parameter, that sorts the members using the specified sort keys.
      • PROPERTIES

        public static final QueryParameter PROPERTIES
        The oslc.properties parameter, that returns a list of properties for an OSLC resource and provides a partial representation of the resource.
      • SELECT

        public static final QueryParameter SELECT
        The oslc.select parameter, that includes the specified immediate and nested properties of the member resources.
      • PAGING

        public static final QueryParameter PAGING
        The oslc.paging parameter, that specifies whether a paged result is requested.
      • PAGE_SIZE

        public static final QueryParameter PAGE_SIZE
        The oslc.pageSize parameter, that specifies a suggested maximum page size for a paged result.
    • Method Detail

      • values

        public static QueryParameter[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (QueryParameter c : QueryParameter.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static QueryParameter valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getName

        public String getName()
        Returns the name of the parameter, as found as query parameter in a URI.
        Returns:
        the name of the parameter.