Enum OrgScopeType

  • All Implemented Interfaces:
    Serializable, Comparable<OrgScopeType>

    public enum OrgScopeType
    extends Enum<OrgScopeType>

    Java class for OrgScopeType.

    The following schema fragment specifies the expected content contained within this class.

     <simpleType name="OrgScopeType">
       <restriction base="{http://www.w3.org/2001/XMLSchema}string">
         <enumeration value="directDescendants"/>
         <enumeration value="allDescendants"/>
         <enumeration value="allAncestors"/>
         <enumeration value="none"/>
       </restriction>
     </simpleType>
     
    • Enum Constant Detail

      • DIRECT_DESCENDANTS

        public static final OrgScopeType DIRECT_DESCENDANTS
        Direct descendants of the reference node. I.e. all the nodes that are exactly one level below.
      • ALL_DESCENDANTS

        public static final OrgScopeType ALL_DESCENDANTS
        All descendants of the reference node, including descendants of descendants. I.e. all the nodes that are one or more levels below.
      • ALL_ANCESTORS

        public static final OrgScopeType ALL_ANCESTORS
        All ancestors of the reference node, including ancestors of ancestors. I.e. all the nodes that are on any path between the reference node and the root node.
      • NONE

        public static final OrgScopeType NONE
        No objects belong to the scope. Used in conjunction with includeReferenceOrg option to target only the reference node and no other node in the hierarchy.
    • Method Detail

      • values

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

        public static OrgScopeType valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()