com.filenet.api.constants

Class DomainType

  • java.lang.Object
    • com.filenet.api.constants.DomainType
  • All Implemented Interfaces:
    java.io.Serializable


    public final class DomainType
    extends java.lang.Object
    implements java.io.Serializable
    Provides a set of constants to indicate the type of a domain. These constants are used in conjunction with the DomainType property of a Domain object to provide client applications a means of discovering the type of the domain: stand-alone, master, or tenant.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static DomainType MASTER
      Indicates that the domain is a master domain.
      static int MASTER_AS_INT
      An int value associated with the MASTER instance of this class.
      static DomainType STANDALONE
      Indicates that the domain is a stand-alone domain.
      static int STANDALONE_AS_INT
      An int value associated with the STANDALONE instance of this class.
      static DomainType TENANT
      Indicates that the domain is a tenant domain.
      static int TENANT_AS_INT
      An int value associated with the TENANT instance of this class.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static DomainType getInstanceFromInt(int value)
      Returns an instance of this class using its associated integer value.
      int getValue()
      Returns the internal integer value associated with a specific instance of this class.
      java.lang.String toString()
      Returns a String representation of this enumeration instance.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • STANDALONE_AS_INT

        public static final int STANDALONE_AS_INT
        An int value associated with the STANDALONE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • STANDALONE

        public static final DomainType STANDALONE
        Indicates that the domain is a stand-alone domain. A stand-alone domain does not allow any tenant domains to be created.
      • MASTER_AS_INT

        public static final int MASTER_AS_INT
        An int value associated with the MASTER instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • MASTER

        public static final DomainType MASTER
        Indicates that the domain is a master domain. A master domain is operationally the same as a stand-alone domain, but it allows for the optional creation of one or more tenant domains, which share the same physical infrastructure and resources as the master domain.
      • TENANT_AS_INT

        public static final int TENANT_AS_INT
        An int value associated with the TENANT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • TENANT

        public static final DomainType TENANT
        Indicates that the domain is a tenant domain. Each tenant domain shares the physical infrastructure and resources of a master domain, but appears to the API to be a stand-alone domain.
    • Method Detail

      • getValue

        public int getValue()
        Returns the internal integer value associated with a specific instance of this class.
        Returns:
        The enumeration instance's ordinal value.
        See Also:
        getInstanceFromInt(int)
      • toString

        public java.lang.String toString()
        Returns a String representation of this enumeration instance.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The enumeration instance's description.
      • getInstanceFromInt

        public static DomainType getInstanceFromInt(int value)
        Returns an instance of this class using its associated integer value.
        Parameters:
        value - The integer value. (See the *_AS_INT fields.)
        Returns:
        The enumeration instance with the given ordinal value.
        Throws:
        EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
        See Also:
        getValue()

© Copyright IBM Corporation 2006, 2015. All rights reserved.