Enum DataSetFetchOption

  • All Implemented Interfaces:
    ch.systemsx.cisd.openbis.generic.shared.basic.dto.FetchOption, java.io.Serializable, java.lang.Comparable<DataSetFetchOption>

    @JsonObject("DataSetFetchOption")
    public enum DataSetFetchOption
    extends java.lang.Enum<DataSetFetchOption>
    implements ch.systemsx.cisd.openbis.generic.shared.basic.dto.FetchOption
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BASIC
      The basic attributes of a dataset like code, registration data, completeness, etc..
      CHILDREN
      The children of a dataset.
      CONTAINED
      The contained datasets of a dataset, if it is a container.
      CONTAINER
      The containers of a dataset, if it is a contained dataset.
      EXPERIMENT
      The experiment that the dataset is connected to.
      METAPROJECTS
      The metaproject information of a dataset for the current user.
      PARENTS
      The parents of a dataset.
      PROPERTIES
      The properties of a dataset.
      PROPERTIES_OF_CHILDREN
      The properties of a all child datasets of a dataset.
      PROPERTIES_OF_PARENTS
      The properties of a all parent datasets of a dataset.
      PROPERTIES_OF_PROPERTIES
      The properties of a all material properties of a dataset.
      SAMPLE
      The sample that the dataset is connected to.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DataSetFetchOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DataSetFetchOption[] 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

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

      • values

        public static DataSetFetchOption[] 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 (DataSetFetchOption c : DataSetFetchOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DataSetFetchOption 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