This topic alphabetically lists the properties that apply to the PropertyDefinitionDateTime 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).
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ
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. |
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
ChoiceList
object that represents the discrete set of possible values
that this property can hold.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ChoiceList
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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 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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
TypeID
constant, which indicates the data type of the value that an object property,
choice list, or database table column can hold.
For PropertyDescription
, PropertyDefinition
, and PropertyTemplate
object types,
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 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.
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. |
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
The text is not locale-specific to the retrieving user except for the following classes:
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
ExternalPropertyAliasList
collection of the external aliases defined for this
property definition or replicable class definition.
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ExternalPropertyAlias
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
true
)
or not (false
).
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AccessRight
and AccessLevel
classes 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.AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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 PropertyPersistenceType 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. |
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: 2
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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()
.AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: DATE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: DATE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: DATE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
PropertyTemplate
subclass (PropertyTemplateBinary
,
for example) that specifies the property template on which this property definition is based.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: PropertyTemplateDateTime
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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. |
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 3
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
For objects in which you can set the SymbolicName property (object store, class definition, and property template), 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 property template objects, 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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
TableDefinition
object for the database table in which this ClassDefinition
or
PropertyDefinition
object resides.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: TableDefinition
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ