fr.gouv.vitam.common.database.builder.request.configuration

Enum BuilderToken.PROJECTIONARGS

java.lang.Object

java.lang.Enum<BuilderToken.PROJECTIONARGS>

fr.gouv.vitam.common.database.builder.request.configuration.BuilderToken.PROJECTIONARGS

All Implemented Interfaces:

Serializable, Comparable<BuilderToken.PROJECTIONARGS>

Enclosing class:

BuilderToken

public static enum BuilderToken.PROJECTIONARGS
extends Enum<BuilderToken.PROJECTIONARGS>

Projection args model

specific fields: nbunits, dua, ...
$fields : [ #nbunits:1, #dua:1, #all:1... ] #all:1 means all, while #all:0 means none

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All fields for the result or None except Id
ALLUNITUPS All Unit's parents
DUA All Dua for the result
FORMAT Object format
ID Id of the item
INITIAL_OPERATION Unit or GOT's initial operation
LAST_PERSISTED_DATE Last persisted date (logbook operation & lifecycle documents)
MANAGEMENT Management bloc
MAX Unit's MAX distance from root
MIN Unit's MIN distance from root
NBCHILD Number of copies or number of children
NBOBJECTS Number of objects within ObjectGroup
NBUNITS Number of units immediate children from this Unit
OBJECT Unit's ObjectGroup
OPERATIONS Unit or GOT's list of participating operations
ORIGINATING_AGENCIES originating agencies
ORIGINATING_AGENCY originating agency
PARENTS parents arrays
QUALIFIERS Qualifiers field
SCORE Document scoring according to research
SIZE Object size
STORAGE Storage field in OG
TENANT Unit/ObjectGroup Tenant
TYPE Unit/ObjectGroup type
UNITTYPE unit type bloc
UNITUPS Unit's immediate parents
USAGE Document's usage (BINARY_MASTER, PHYSICAL_MASTER, DISSEMINATION, ...)
VERSION Document's version (number of update on document)

Method Summary

Modifier and Type	Method and Description
String	exactToken()
static BuilderToken.PROJECTIONARGS	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuilderToken.PROJECTIONARGS[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final BuilderToken.PROJECTIONARGS ID

Id of the item

NBUNITS

public static final BuilderToken.PROJECTIONARGS NBUNITS

Number of units immediate children from this Unit

NBOBJECTS

public static final BuilderToken.PROJECTIONARGS NBOBJECTS

Number of objects within ObjectGroup

NBCHILD

public static final BuilderToken.PROJECTIONARGS NBCHILD

Number of copies or number of children

DUA

public static final BuilderToken.PROJECTIONARGS DUA

All Dua for the result

ALL

public static final BuilderToken.PROJECTIONARGS ALL

All fields for the result or None except Id

QUALIFIERS

public static final BuilderToken.PROJECTIONARGS QUALIFIERS

Qualifiers field

SIZE

public static final BuilderToken.PROJECTIONARGS SIZE

Object size

FORMAT

public static final BuilderToken.PROJECTIONARGS FORMAT

Object format

TYPE

public static final BuilderToken.PROJECTIONARGS TYPE

Unit/ObjectGroup type

TENANT

public static final BuilderToken.PROJECTIONARGS TENANT

Unit/ObjectGroup Tenant

OBJECT

public static final BuilderToken.PROJECTIONARGS OBJECT

Unit's ObjectGroup

UNITUPS

public static final BuilderToken.PROJECTIONARGS UNITUPS

Unit's immediate parents

MIN

public static final BuilderToken.PROJECTIONARGS MIN

Unit's MIN distance from root

MAX

public static final BuilderToken.PROJECTIONARGS MAX

Unit's MAX distance from root

ALLUNITUPS

public static final BuilderToken.PROJECTIONARGS ALLUNITUPS

All Unit's parents

MANAGEMENT

public static final BuilderToken.PROJECTIONARGS MANAGEMENT

Management bloc

ORIGINATING_AGENCY

public static final BuilderToken.PROJECTIONARGS ORIGINATING_AGENCY

originating agency

ORIGINATING_AGENCIES

public static final BuilderToken.PROJECTIONARGS ORIGINATING_AGENCIES

originating agencies

STORAGE

public static final BuilderToken.PROJECTIONARGS STORAGE

Storage field in OG

UNITTYPE

public static final BuilderToken.PROJECTIONARGS UNITTYPE

unit type bloc

PARENTS

public static final BuilderToken.PROJECTIONARGS PARENTS

parents arrays

OPERATIONS

public static final BuilderToken.PROJECTIONARGS OPERATIONS

Unit or GOT's list of participating operations

INITIAL_OPERATION

public static final BuilderToken.PROJECTIONARGS INITIAL_OPERATION

Unit or GOT's initial operation

VERSION

public static final BuilderToken.PROJECTIONARGS VERSION

Document's version (number of update on document)

USAGE

public static final BuilderToken.PROJECTIONARGS USAGE

Document's usage (BINARY_MASTER, PHYSICAL_MASTER, DISSEMINATION, ...)

SCORE

public static final BuilderToken.PROJECTIONARGS SCORE

Document scoring according to research

LAST_PERSISTED_DATE

public static final BuilderToken.PROJECTIONARGS LAST_PERSISTED_DATE

Last persisted date (logbook operation & lifecycle documents)

Method Detail

values

public static BuilderToken.PROJECTIONARGS[] 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.PROJECTIONARGS c : BuilderToken.PROJECTIONARGS.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.PROJECTIONARGS 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

exactToken

public final String exactToken()

Returns:

the exact token