@JsonObject(value="SampleFetchOption") public enum SampleFetchOption extends java.lang.Enum<SampleFetchOption> implements ch.systemsx.cisd.openbis.generic.shared.basic.dto.FetchOption
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 and Description |
---|
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.
|
CONTAINED
Ask for contained samples.
|
DESCENDANTS
Ask for all descendants.
|
METAPROJECTS
Ask for metaprojects this sample belongs to.
|
PARENTS
Samples contain also their parent samples.
|
PROPERTIES
Samples contain basic attributes and all properties.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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
public static final SampleFetchOption CONTAINED
public static final SampleFetchOption METAPROJECTS
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 namejava.lang.NullPointerException
- if the argument is null