Enum CollectionStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CollectionStatus>

    public enum CollectionStatus
    extends java.lang.Enum<CollectionStatus>
    implements java.io.Serializable
    CollectionStatus specifies which subset of a collection should be returned. The relationship that links a member into a collection has an start and end date (called the effective dates). The Community Profile OMAS uses the CollectionStatus and the effective dates to determine which members to return.
    • ACTIVE - all the collection members with a current effective dates. This is the default.
    • PAST - all the collection members that have effective dates in the past.
    • FUTURE - all the collection members that become effective in the future.
    • ALL - all the collection members linked to the collection irrespective of their effective dates.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACTIVE  
      ALL  
      FUTURE  
      PAST  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description of the enumeration.
      java.lang.String getName()
      Return the default name of the enumeration.
      int getOrdinal()
      Return the numeric representation of the enumeration.
      java.lang.String toString()
      toString() JSON-style
      static CollectionStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CollectionStatus[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

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

        public static CollectionStatus 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
      • getOrdinal

        public int getOrdinal()
        Return the numeric representation of the enumeration.
        Returns:
        int ordinal
      • getName

        public java.lang.String getName()
        Return the default name of the enumeration.
        Returns:
        String name
      • getDescription

        public java.lang.String getDescription()
        Return the default description of the enumeration.
        Returns:
        String description
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<CollectionStatus>
        Returns:
        string description