com.filenet.api.constants

Class PropertySettability

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


    public final class PropertySettability
    extends java.lang.Object
    implements java.io.Serializable
    Provides a set of constants that specify when the value of a property can be set. These constants are used by the Settability property.
    See Also:
    Serialized Form
    • Method Summary

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

      • READ_WRITE_AS_INT

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

        public static final PropertySettability READ_WRITE
        Specifies that a property is read/write; you can set its value at any time.
      • READ_ONLY_AS_INT

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

        public static final PropertySettability READ_ONLY
        Specifies that a property is read-only; only the server can set its value.
      • SETTABLE_ONLY_ON_CREATE_AS_INT

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

        public static final PropertySettability SETTABLE_ONLY_ON_CREATE
        Specifies that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property becomes read-only.
      • SETTABLE_ONLY_BEFORE_CHECKIN_AS_INT

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

        public static final PropertySettability SETTABLE_ONLY_BEFORE_CHECKIN
        Specifies that you can only set the value of a property before you check in the object to which it belongs.
    • 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 PropertySettability 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.