Enum BuilderToken.SELECTFILTER
- java.lang.Object
-
- java.lang.Enum<BuilderToken.SELECTFILTER>
-
- fr.gouv.vitam.common.database.builder.request.configuration.BuilderToken.SELECTFILTER
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BuilderToken.SELECTFILTER>
- Enclosing class:
- BuilderToken
public static enum BuilderToken.SELECTFILTER extends java.lang.Enum<BuilderToken.SELECTFILTER>
SelectFilter model
-
-
Enum Constant Summary
Enum Constants Enum Constant Description HINT
Allows to specify some hints to the request server: cache/nocache
$hint : [ cache/nocache, ...LIMIT
Limit the elements returned to the nth first elements $limit : nOFFSET
According to an orderby, start to return the elements from rank start
$offset : startORDERBY
Specify an orderby to respect in the return of the elements according to one field named 'name' and an orderby ascendant (+1) or descendant (-1)
$orderby : [ { key : +/-1 } ]SCROLL_ID
scrollId for scroll functionality $scrollIdSCROLL_TIMEOUT
scrollTimeout expiry time for scrollIdTRACK_TOTAL_HITS
Allow computing total hits.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
exactToken()
static BuilderToken.SELECTFILTER
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static BuilderToken.SELECTFILTER[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LIMIT
public static final BuilderToken.SELECTFILTER LIMIT
Limit the elements returned to the nth first elements $limit : n
-
SCROLL_ID
public static final BuilderToken.SELECTFILTER SCROLL_ID
scrollId for scroll functionality $scrollId
-
SCROLL_TIMEOUT
public static final BuilderToken.SELECTFILTER SCROLL_TIMEOUT
scrollTimeout expiry time for scrollId
-
OFFSET
public static final BuilderToken.SELECTFILTER OFFSET
According to an orderby, start to return the elements from rank start
$offset : start
-
ORDERBY
public static final BuilderToken.SELECTFILTER ORDERBY
Specify an orderby to respect in the return of the elements according to one field named 'name' and an orderby ascendant (+1) or descendant (-1)
$orderby : [ { key : +/-1 } ]
-
HINT
public static final BuilderToken.SELECTFILTER HINT
Allows to specify some hints to the request server: cache/nocache
$hint : [ cache/nocache, ... ]
-
TRACK_TOTAL_HITS
public static final BuilderToken.SELECTFILTER TRACK_TOTAL_HITS
Allow computing total hits.
-
-
Method Detail
-
values
public static BuilderToken.SELECTFILTER[] 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 (BuilderToken.SELECTFILTER c : BuilderToken.SELECTFILTER.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static BuilderToken.SELECTFILTER valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
exactToken
public final java.lang.String exactToken()
- Returns:
- the exact token
-
-