Enum QueryParameter
- java.lang.Object
-
- java.lang.Enum<QueryParameter>
-
- com.sodius.oslc.core.process.query.QueryParameter
-
- All Implemented Interfaces:
Serializable
,Comparable<QueryParameter>
public enum QueryParameter extends Enum<QueryParameter>
OSLC Query parameter names, as defined by the specification.- Since:
- 3.6.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ORDER_BY
Theoslc.orderBy
parameter, that sorts the members using the specified sort keys.PAGE_SIZE
Theoslc.pageSize
parameter, that specifies a suggested maximum page size for a paged result.PAGING
Theoslc.paging
parameter, that specifies whether a paged result is requested.PREFIX
Theoslc.prefix
parameter, that specifies a namespace prefix that may be used inoslc.where
,oslc.orderBy
,and oslc.select
.PROPERTIES
Theoslc.properties
parameter, that returns a list of properties for an OSLC resource and provides a partial representation of the resource.SEARCH_TERMS
Theoslc.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
Theoslc.select
parameter, that includes the specified immediate and nested properties of the member resources.WHERE
Theoslc.where
parameter, that limits the query results to members that satisfy the specified query expression.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Returns the name of the parameter, as found as query parameter in a URI.static QueryParameter
valueOf(String name)
Returns the enum constant of this type with the specified name.static QueryParameter[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PREFIX
public static final QueryParameter PREFIX
Theoslc.prefix
parameter, that specifies a namespace prefix that may be used inoslc.where
,oslc.orderBy
,and oslc.select
.
-
WHERE
public static final QueryParameter WHERE
Theoslc.where
parameter, that limits the query results to members that satisfy the specified query expression.
-
SEARCH_TERMS
public static final QueryParameter SEARCH_TERMS
Theoslc.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
Theoslc.orderBy
parameter, that sorts the members using the specified sort keys.
-
PROPERTIES
public static final QueryParameter PROPERTIES
Theoslc.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
Theoslc.select
parameter, that includes the specified immediate and nested properties of the member resources.
-
PAGING
public static final QueryParameter PAGING
Theoslc.paging
parameter, that specifies whether a paged result is requested.
-
PAGE_SIZE
public static final QueryParameter PAGE_SIZE
Theoslc.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 nameNullPointerException
- 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.
-
-