com.filenet.api.constants
Class PropertyPersistence
- java.lang.Object
-
- com.filenet.api.constants.PropertyPersistence
-
- All Implemented Interfaces:
- java.io.Serializable
public final class PropertyPersistence extends java.lang.Object implements java.io.Serializable
Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static PropertyPersistence
NOT_PERSISTENT
Specifies that a property cannot be made persistent.static int
NOT_PERSISTENT_AS_INT
Anint
value associated with the NOT_PERSISTENT instance of this class.static PropertyPersistence
OWN_COLUMN
Specifies that a property has a dedicated column in the database and therefore can be made persistent.static int
OWN_COLUMN_AS_INT
Anint
value associated with the OWN_COLUMN instance of this class.static PropertyPersistence
OWN_TABLE
Specifies that the property has a dedicated table in the database and therefore can be made persistent.static int
OWN_TABLE_AS_INT
Anint
value associated with the OWN_TABLE instance of this class.
-
Method Summary
Methods Modifier and Type Method and Description static PropertyPersistence
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 aString
representation of this enumeration instance.
-
-
-
Field Detail
-
OWN_TABLE_AS_INT
public static final int OWN_TABLE_AS_INT
Anint
value associated with the OWN_TABLE 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
-
OWN_TABLE
public static final PropertyPersistence OWN_TABLE
Specifies that the property has a dedicated table in the database and therefore can be made persistent. This setting applies only to multi-valued scalar (non-object) properties and causes the server to store a property's values into a custom table, which is generated by the server when its property template is first assigned to a class definition as a property definition. The name of this table is derived from the name of the corresponding property. Once it has been created, the same table will be used to store the property's values, regardless of the class to which the property is assigned.
-
OWN_COLUMN_AS_INT
public static final int OWN_COLUMN_AS_INT
Anint
value associated with the OWN_COLUMN 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
-
OWN_COLUMN
public static final PropertyPersistence OWN_COLUMN
Specifies that a property has a dedicated column in the database and therefore can be made persistent.
-
NOT_PERSISTENT_AS_INT
public static final int NOT_PERSISTENT_AS_INT
Anint
value associated with the NOT_PERSISTENT 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
-
NOT_PERSISTENT
public static final PropertyPersistence NOT_PERSISTENT
Specifies that a property cannot be made persistent. If a property is defined asNOT_PERSISTENT
, has a default value defined, and the Settability property of its property template has a value ofPropertySettability.READ_ONLY
, the property is considered to be a constant and will always return its default value for any instance of the property that is returned.
-
-
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 aString
representation of this enumeration instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- The enumeration instance's description.
-
getInstanceFromInt
public static PropertyPersistence 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()
-
-