The IPropertyTemplateFloat64 type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAliasIds
Specifies an 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).
(Inherited from IPropertyTemplate.)
Public propertyAuditAs
References an IPropertyTemplate 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 IPropertyDefinition.AuditAs to an existing IPropertyTemplate, which typically is the same object from which the IPropertyDefinition 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 an IPropertyDefintion as long as that IPropertyDefinition does not already inherit an AuditAs value. Once set, its value is automatically inherited as read-only in subclasses. If the IPropertyDefinition 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 IPropertyDescription, AuditAs is read only.

(Inherited from IPropertyTemplate.)
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IPropertyTemplate.)
Public propertyCardinality
Specifies a 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:

  • For PropertyDescriptionObject and PropertyDefinitionObject objects only, this property can have any Cardinality constant value: SINGLE, ENUM, or LIST.
  • For all other 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:

  • For 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.
  • For all other PropertyTemplate object types, this property must have a value of SINGLE or LIST.

(Inherited from IPropertyTemplate.)
Public propertyChoiceList
Specifies a ChoiceList object that represents the discrete set of possible values that this property can hold.
(Inherited from IPropertyTemplate.)
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from IPropertyTemplate.)
Public propertyDataType
Specifies a 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.
(Inherited from IPropertyTemplate.)
Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from IPropertyTemplate.)
Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from IPropertyTemplate.)
Public propertyDescriptiveText
User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription
  • ClassDefinition
  • PropertyTemplate
  • PropertyDefinition
(Inherited from IPropertyTemplate.)
Public propertyDescriptiveTexts
Specifies a LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable description of a class or property.
(Inherited from IPropertyTemplate.)
Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For ICmAuditProcessingBookmark and IAuditDefinition 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 ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

(Inherited from IPropertyTemplate.)
Public propertyDisplayNames
Specifies a LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable display name for a class definition, property template, or choice.
(Inherited from IPropertyTemplate.)
Public propertyExternalReplicaIdentities
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.)
Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup 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, IUser.Id and IGroup.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.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

(Inherited from IPropertyTemplate.)
Public propertyInstalledByAddOn
Indicates the AddOn that installed this object. If null, this object was either created by the system or an external application.
(Inherited from IPropertyTemplate.)
Public propertyIsHidden
Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).
(Inherited from IPropertyTemplate.)
Public propertyIsNameProperty
Specifies whether the value of a property provides the name of the object instances of the class to which it belongs (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.
(Inherited from IPropertyTemplate.)
Public propertyIsValueRequired
Indicates whether the property represented by a given property description, property definition, or property template is required to have a value (true) or not (false). If you attempt to save an object containing a property that requires a value and that property does not have a value assigned to it, an exception will result.
(Inherited from IPropertyTemplate.)
Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from IPropertyTemplate.)
Public propertyModificationAccessRequired
Specifies the access rights that are required to change the value of a given property on the object instances on which the property occurs. To specify access rights, use the AccessRight class in the com.filenet.api.constants package. You can:
  • set the value of the ModificationAccessRequired property when creating a given property
  • modify its value after creating the given property
  • modify its value on the ClassDefinition object when creating a document class.
(Inherited from IPropertyTemplate.)
Public propertyName
The name for this object.

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.

(Inherited from IPropertyTemplate.)
Public propertyOwner
Manages the security owner assigned to the object.
(Inherited from IPropertyTemplate.)
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
(Inherited from IPropertyTemplate.)
Public propertyPersistenceType
Specifies a 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.
(Inherited from IPropertyTemplate.)
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyPropertyDefaultFloat64
Specifies the default value for a property that returns a DOUBLE data type.
Public propertyPropertyDisplayCategory
Specifies a string that is used to group related properties together for display and sorting purposes.
(Inherited from IPropertyTemplate.)
Public propertyPropertyMaximumFloat64
Specifies the maximum value for a property that returns a DOUBLE data type.
Public propertyPropertyMinimumFloat64
Specifies the minimum value for a property that returns a DOUBLE data type.
Public propertyReplicationGroup
A ReplicationGroup object representing the replication group to which this replicable object belongs.

For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

(Inherited from IReplicable.)
Public propertyRequiresUniqueElements
Specifies the uniqueness of elements in a multi-valued property or a database index.

For a CmIndexDefinition object, specifies whether an index is unique (true) or not (false).

For all other objects, specifies whether the values of a multi-valued property must be unique (true) or not (false).

(Inherited from IPropertyTemplate.)
Public propertySettability
Specifies a 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.
(Inherited from IPropertyTemplate.)
Public propertySymbolicName
The programmatic identifier for this class description, class definition, property description, property definition, property template, or object store. The value of the property is treated in a case-insensitive manner.

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 the symbolic name to a value beginning with one of the following 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 a property template object, the symbolic name need not be unique relative to the other property template objects. However, when you use a property template to create a property definition and associate it with a class, that property definition's symbolic name must be unique within the class family. 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 will propagate to the property definitions based on that template. The property definitions that have 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.

(Inherited from IPropertyTemplate.)
Public propertyUsedInClasses
Specifies a ClassDefinitionSet object representing the classes that have a property constructed from this property template.
(Inherited from IPropertyTemplate.)

ToggleSee Also