Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Enum Class DataSetFetchOption

java.lang.Object
java.lang.Enum<DataSetFetchOption>
ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetFetchOption
All Implemented Interfaces:
FetchOption, Serializable, Comparable<DataSetFetchOption>, Constable
@JsonObject("DataSetFetchOption") public enum DataSetFetchOption extends Enum<DataSetFetchOption> implements FetchOption

  • Enum Constant Details

    • BASIC

      public static final DataSetFetchOption BASIC
      The basic attributes of a dataset like code, registration data, completeness, etc..

    • EXPERIMENT

      public static final DataSetFetchOption EXPERIMENT
      The experiment that the dataset is connected to.

    • SAMPLE

      public static final DataSetFetchOption SAMPLE
      The sample that the dataset is connected to.

    • PROPERTIES

      public static final DataSetFetchOption PROPERTIES
      The properties of a dataset.

    • PROPERTIES_OF_PROPERTIES

      public static final DataSetFetchOption PROPERTIES_OF_PROPERTIES
      The properties of a all material properties of a dataset.

    • PROPERTIES_OF_PARENTS

      public static final DataSetFetchOption PROPERTIES_OF_PARENTS
      The properties of a all parent datasets of a dataset.

    • PROPERTIES_OF_CHILDREN

      public static final DataSetFetchOption PROPERTIES_OF_CHILDREN
      The properties of a all child datasets of a dataset.

    • PARENTS

      public static final DataSetFetchOption PARENTS
      The parents of a dataset.

    • CHILDREN

      public static final DataSetFetchOption CHILDREN
      The children of a dataset.

    • CONTAINER

      public static final DataSetFetchOption CONTAINER
      The containers of a dataset, if it is a contained dataset.

    • CONTAINED

      public static final DataSetFetchOption CONTAINED
      The contained datasets of a dataset, if it is a container.

    • METAPROJECTS

      public static final DataSetFetchOption METAPROJECTS
      The metaproject information of a dataset for the current user.

  • Method Details

    • values

      public static DataSetFetchOption[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DataSetFetchOption valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null