|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<SampleFetchOption>
ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption
@JsonObject(value="SampleFetchOption") public enum SampleFetchOption
Fetch options for
IGeneralInformationService.searchForSamples(String, SearchCriteria, java.util.EnumSet)
.
The Sample
objects return by the search method also contain a fetch option (
Sample.getRetrievedFetchOptions()
) which tells which attributes are filled and which not.
Enum Constant Summary | |
---|---|
ANCESTORS
Ask for all ancestors. |
|
BASIC
Samples will have only basic attributes (id, code, type, space code, experiment identifier, registrator, registration date, modification date) but no properties. |
|
CHILDREN
Samples contain also their children samples. |
|
DESCENDANTS
Ask for all descendants. |
|
PARENTS
Samples contain also their parent samples. |
|
PROPERTIES
Samples contain basic attributes and all properties. |
Method Summary | |
---|---|
static SampleFetchOption |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static SampleFetchOption[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final SampleFetchOption BASIC
public static final SampleFetchOption PROPERTIES
public static final SampleFetchOption PARENTS
public static final SampleFetchOption CHILDREN
public static final SampleFetchOption ANCESTORS
public static final SampleFetchOption DESCENDANTS
Method Detail |
---|
public static SampleFetchOption[] values()
for (SampleFetchOption c : SampleFetchOption.values()) System.out.println(c);
public static SampleFetchOption valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is null
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |