ch.systemsx.cisd.openbis.generic.shared.api.v1.dto
Enum SampleFetchOption

java.lang.Object
  extended by java.lang.Enum<SampleFetchOption>
      extended by ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SampleFetchOption
All Implemented Interfaces:
ch.systemsx.cisd.openbis.generic.shared.basic.dto.FetchOption, java.io.Serializable, java.lang.Comparable<SampleFetchOption>

@JsonObject(value="SampleFetchOption")
public enum SampleFetchOption
extends java.lang.Enum<SampleFetchOption>
implements ch.systemsx.cisd.openbis.generic.shared.basic.dto.FetchOption

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.
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.
 
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

BASIC

public static final SampleFetchOption BASIC
Samples will have only basic attributes (id, code, type, space code, experiment identifier, registrator, registration date, modification date) but no properties.


PROPERTIES

public static final SampleFetchOption PROPERTIES
Samples contain basic attributes and all properties.


PARENTS

public static final SampleFetchOption PARENTS
Samples contain also their parent samples.


CHILDREN

public static final SampleFetchOption CHILDREN
Samples contain also their children samples.


ANCESTORS

public static final SampleFetchOption ANCESTORS
Ask for all ancestors.


DESCENDANTS

public static final SampleFetchOption DESCENDANTS
Ask for all descendants.


CONTAINED

public static final SampleFetchOption CONTAINED
Ask for contained samples. This is not supported in search operations


METAPROJECTS

public static final SampleFetchOption METAPROJECTS
Ask for metaprojects this sample belongs to.

Method Detail

values

public static SampleFetchOption[] 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 (SampleFetchOption c : SampleFetchOption.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SampleFetchOption 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 name
java.lang.NullPointerException - if the argument is null