Package com.comsol.api.database

Enum QueryItemVersionInclusionOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<QueryItemVersionInclusionOption>
    public enum QueryItemVersionInclusionOption
extends java.lang.Enum<QueryItemVersionInclusionOption>
    Enumeration of options used to specify the inclusion of related items' versions when querying for versions associated with a specific item.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INCLUDE_ANCILLARY
      Include versions belonging to so-called ancillary items having the item as their origin in the query result.

    • Method Summary

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

      • INCLUDE_ANCILLARY

        public static final QueryItemVersionInclusionOption INCLUDE_ANCILLARY
        Include versions belonging to so-called ancillary items having the item as their origin in the query result. Using this option will, for example, include all versions of drafts that have been created from a regular model in the query result.
        See Also:
        ItemSaveType

    • Constructor Detail

      • QueryItemVersionInclusionOption

        private QueryItemVersionInclusionOption()

    • Method Detail

      • values

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

      • valueOf

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