com.filenet.api.constants

Class IndexingStatus

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


    public final class IndexingStatus
    extends java.lang.Object
    implements java.io.Serializable
    Provides a set of constants that specify the load balancing status of an IBM® Content Search Services index. These constants are used by the IndexingStatus property of the index. The Content Engine server automatically reassigns an index to another IBM Content Search Services server, if necessary, to balance the indexing workload of the server.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static IndexingStatus NORMAL
      The index is assigned to an IBM Content Search Services server and does not need to be reassigned.
      static int NORMAL_AS_INT
      An int value associated with the NORMAL instance of this class.
      static IndexingStatus REBALANCING
      The index is in the process of being reassigned to a new IBM Content Search Services server.
      static int REBALANCING_AS_INT
      An int value associated with the REBALANCING instance of this class.
      static IndexingStatus REPLACING
      The index is unavailable and an index job has set the ResourceStatus property of the index to CLOSED.
      static int REPLACING_AS_INT
      An int value associated with the REPLACING instance of this class.
      static IndexingStatus RESYNCHING 
      static int RESYNCHING_AS_INT
      An int value associated with the RESYNCHING instance of this class.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static IndexingStatus 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

      • NORMAL_AS_INT

        public static final int NORMAL_AS_INT
        An int value associated with the NORMAL 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
      • NORMAL

        public static final IndexingStatus NORMAL
        The index is assigned to an IBM Content Search Services server and does not need to be reassigned.
      • REBALANCING_AS_INT

        public static final int REBALANCING_AS_INT
        An int value associated with the REBALANCING 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
      • REBALANCING

        public static final IndexingStatus REBALANCING
        The index is in the process of being reassigned to a new IBM Content Search Services server. When the index is in this state, you cannot change the value of its ResourceStatus property via the API. After the reassignment is complete, the following properties of the index are changed by the Content Engine server:
        • The CurrentIndexServer property is set to the ID of the new server.
        • The LeaseExpiryTime property is set to a new expiration time.
        • The IndexingStatus property is set to NORMAL.
      • REPLACING_AS_INT

        public static final int REPLACING_AS_INT
        An int value associated with the REPLACING 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
      • REPLACING

        public static final IndexingStatus REPLACING
        The index is unavailable and an index job has set the ResourceStatus property of the index to CLOSED. When the index is in this state, you cannot change the value of its ResourceStatus property via the API.
      • RESYNCHING_AS_INT

        public static final int RESYNCHING_AS_INT
        An int value associated with the RESYNCHING 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
    • 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 IndexingStatus 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, 2013. All rights reserved.