This topic alphabetically lists the properties that apply to the PropertyDefinitionFloat64 class.
IdList
object containing a list of optional alias IDs for this class definition,
property definition, or property template. Depending on the type of object to which it belongs, an alias
ID is set equal to the PrimaryId of another property definition, the Id of another property template, or the
Id of another class definition in another object store to equate the two properties or classes as being the
same entity in multiple object store searches (see the SearchScope
class).
PropertyTemplate
that represents an individual property to be audited in a class.
An audited source property in a class is mapped to an event property in an audit record of the Event table.
By default, AuditAs is set to null
.
Custom properties can be audited by setting PropertyDefinition.AuditAs
to an existing PropertyTemplate
,
which typically is the same object from which the PropertyDefinition
was created.
However, system properties do not have pre-existing property templates, so you must create a new property template for a system property
that you want to audit. For code examples, see Configuring Property Auditing.
AuditAs is settable on a PropertyDefinition
as long as that PropertyDefinition
does not already inherit an AuditAs value.
Once set, its value is automatically inherited as read-only in subclasses.
If the PropertyDefinition
referenced by an AuditAs property is deleted, then that AuditAs property becomes settable on all immediate subclasses.
For example, if root class A has a property P that is audited, and also has immediate subclasses A1 and A2,
then P on A1 and P on A2 (referred to as P1 and P2) are inherited, with the same AuditAs value as set on A.P.
If A.P is deleted, P1 and P2 get promoted to non-inherited properties on A1 and A2, respectively.
As non-inherited properties, P1 and P2 now have AuditAs values that can be modified to point to a different property, independently of each other.
On PropertyDescription
, AuditAs is read only.
Cardinality
constant, which indicates whether an object property can hold a single value
(single cardinality) or a collection of multiple values (list or enumeration cardinality). You can only set the Cardinality
property when you create a new property template. When you create a property definition from a property template,
its Cardinality property will be automatically populated with the same value as that of the property template
on which it is based. Once you have instantiated an object from the class to which the property definition belongs, the
property defined by the property definition will have the specified cardinality.
For PropertyDescription
and PropertyDefinition
object types, this property is read-only:
PropertyDescriptionObject
and PropertyDefinitionObject
objects only, this
property can have any Cardinality
constant value: SINGLE
, ENUM
, or LIST
.PropertyDescription
and PropertyDefinition
object types, this
property must have a value of SINGLE
or LIST
.
For PropertyTemplate
object types, this property is settable on create:
PropertyTemplateObject
objects only, this property must have a value of SINGLE
or ENUM
. You can only create a custom object-valued property that has single or enumeration cardinality;
list cardinality is allowed for system object-valued properties only.PropertyTemplate
object types, this property must have a value of SINGLE
or LIST
.The Cardinality property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
ENUM |
1 | Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects. |
LIST |
2 | Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality. |
SINGLE |
0 | Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold. |
ChoiceList
object that represents the discrete set of possible values
that this property can hold.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
For a PropertyDefinition
object, a value indicating whether the value of the property defined by this
property definition should be copied, during checkout, from the source document to the newly created reservation object.
For a PropertyDescription
object, CopyToReservation is read only.
For a ComponentRelationship
object, a value indicating whether this object gets copied, during
checkout of the parent component source document, for the newly created reservation object. The reservation object
becomes the parent component for the new copy of this ComponentRelationship
object. Consequently,
both the reservation object and the source document have an equivalent component relationship with the same child document.
Note that the reservation object behaves like any other document with respect to compound document properties and relationships.
TypeID
constant, which indicates the data type of the value that an object can hold.
For PropertyDescription
, PropertyDefinition
, and PropertyTemplate
objects,
this property is read-only and specifies the data type of the value that an object property can hold.
Because the value of the DataType property is automatically set by the Content Engine server to correspond
to the specific object type of the PropertyDescription
, PropertyDefinition
,
or PropertyTemplate
object, you do not need to set it when you are creating a property template or
property definition. For example, in a PropertyDescriptionBinary
, PropertyDefinitionBinary
,
or PropertyTemplateBinary
object, the server automatically sets the DataType property
to a value of BINARY
.
For ChoiceList
objects, this property is settable on create and must be a LONG
or
STRING
constant value. This property determines whether a choice list is an integer-type choice list, which holds
integer-type choice items or a string-type choice list, which holds string-type choice items.
For ColumnDefinition
objects, this property is read-only and specifies the data type of the object property
value that is stored in the represented database table column.
For CmIndexPartitionConstraint
objects, this property is read-only and specifies the data type of an index partition constraint.
Only the following values are valid:
DATE
: Specifies a date index partition constraint.STRING
: Specifies a string index partition constraint.The DataType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
BINARY |
1 | Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes. |
BOOLEAN |
2 | Specifies a Boolean data type. Represents Boolean data having a value of true or false . |
DATE |
3 | Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601. |
DOUBLE |
4 | Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308. |
GUID |
5 | Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. |
LONG |
6 | Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647. |
OBJECT |
7 | Specifies an object data type. Represents an object that is instantiated from a Content Engine class. |
STRING |
8 | Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters. |
The text is not locale-specific to the retrieving user except for the following classes:
Name
property of the object's class.
For CmAuditProcessingBookmark
and AuditDefinition
objects, this property is intended to identify client applications
that process the audit log.
For CmAuditProcessingBookmark
objects, this property, in support of the audit disposition feature, identifies the client that created the object.
For AuditDefinition
objects, this property identifies a set of audit definitions for a given client or client functionality.
For CmAuditProcessingBookmark
and AuditDefinition
objects, it is recommended that you set this property.
Specify a unique value to distinguish one client application from another.
Note, however, that the server does not prevent identical display names across multiple
CmAuditProcessingBookmark
or AuditDefinition
objects. Therefore, the client application is responsible for enforcing uniqueness.
ExternalPropertyAliasList
collection of the external aliases defined for this
property definition or replicable class definition.
For User
and Group
classes, the Id property takes the value of the
Security Identifier (SID) rather than the 128-bit GUID. The string representation of the
SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269
.
When Active Directory is used as the directory service for IBM FileNet P8, calls to
User.get_Id()
and Group.get_Id()
always return the current SID for the
principal, even if this user or group has only historical SIDs populating the Active
Directory server.
For a given property representation, the Id property has the following characteristics:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.
For a newly created document object, you can override the Id property of its associated VersionSeries
object
before you save or check in the document for the first time.
true
)
or not (false
).
true
) or not (false
). An object that has a designated name property (the IsNameProperty property
of one of its properties is set or the NamePropertyIndex property of the object's class description is set)
will have the designated name property's value assigned to its Name property. An object can have only one
designated name property.
AccessRight
class in the
com.filenet.api.constants
package. You can:
ModificationAccessRequired
property when creating a given propertyset_ModificationAccessRequired
to modify its value after creating the given propertyClassDefinition
object when creating a document class.For most classes, this property is read-only and returns the value of the designated name property for the object,
or its ID if there is no name property. If ClassDescription.NamePropertyIndex
has a value,
this property contains the value of the designated name property. If there is no designated name property value, and
the object has an Id property, this property contains the string value of the Id property. If neither of these conditions
is satisfied, this property contains an empty string.
For a ComponentRelationship
object, this property is read/write and specifies the name of the object.
PropertyPersistence
constant that indicates whether a property can be
made persistent (that is, have its state stored in a database). If a property can be made persistent,
it must have either a dedicated column or a dedicated table in the database.
The PersistenceType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
NOT_PERSISTENT |
0 | Specifies that a property cannot be made persistent. If a property is defined as NOT_PERSISTENT ,
has a default value defined, and the Settability property of its property template has a value of PropertySettability.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. |
OWN_COLUMN |
1 | Specifies that the property has a dedicated column in the database and therefore can be made persistent. |
OWN_TABLE |
1 | 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. |
Property definitions that exist on different classes but are derived from the same property template will all have the same PrimaryId property value. Because multiple property definitions can be created from the same property template and a property definition's Id property must be unique for every property definition in every class, a property definition's PrimaryId property will not be equal to its Id property. For a given property representation, the PrimaryId property has the following characteristics:
PropertyDefinition.get_PrimaryId()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDescription.get_Id()
.PropertyDefinition.get_PrimaryId()
is not equal to PropertyDefinition.get_Id()
PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.PropertyTemplate
subclass (PropertyTemplateBinary
,
for example) that specifies the property template on which this property definition is based.
PropertySettability
constant, which indicates when the value of a property can be set:
For special system property cases in which privileged write access may be granted, the PrivilegedSettability property
governs the property's settability for users who have AccessRight.PRIVILEGED_SETTABILITY
access,
while the Settability property continues to indicate the property's settability for all other users. See the description of the
PrivilegedSettability property for these special cases.
The Settability property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
READ_ONLY |
3 | Indicates that a property is read-only; only the server can set its value. |
READ_WRITE |
0 | Indicates that a property is read/write; you can set its value at any time. |
SETTABLE_ONLY_BEFORE_CHECKIN |
1 | Indicates that you can only set the value of a property before you check in the object to which it belongs. |
SETTABLE_ONLY_ON_CREATE |
2 | Indicates 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's value cannot be changed. |
For objects in which you can set the SymbolicName property (object store, class definition, and property template objects), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object. For class definition and property template objects, avoid assigning its symbolic name to a value beginning with one of the reserved prefixes: Cm, Dita, and RM.
For object store objects, the symbolic name for an object store must be unique within a domain.
For class definition objects, the symbolic name for a class must be unique within an object store.
For property template objects, the symbolic name for a property must be unique within a class family only.
A class family is defined by a root class (for example, Document
, Folder
, or CustomObject
)
and all of its descendants. Changing the symbolic name of a property template for a string-valued property that has
been enabled for full-text indexing (IsCBREnabled property set to true
) will require re-indexing of all
objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.
TableDefinition
object for the database table in which this ClassDefinition
or
PropertyDefinition
object resides.