Public Properties

  Name Description
Public property AliasIds 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).
Public property AllowsInstances Indicates whether an application can create an object instance of a given class. If this property is false, only the Content Engine server can instantiate the class.
Public property AllowsPropertyAdditions Specifies whether user-defined properties can be added to a class defined by a given class definition (true) or not (false).
Public property AllowsSubclasses Specifies whether you can create subclasses from a class defined by a given class definition (true) or not (false).
Public property AuditedEvents An EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public property Creator 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.

Public property DateCreated Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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.

Public property DateLastModified Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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).

Public property DefaultInstanceOwner The default security owner for an object of a given class. This property is useful if you want a group or user other than the object's creator to have owner security rights.
Public property DefaultInstancePermissionDescriptions A list of descriptions of default permissions to be used when creating an instance of a given class.
Public property DefaultInstancePermissions The default discretionary permissions to be used when creating an instance of a given class.
Public property DescriptiveText 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*
Public property DescriptiveTexts 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.
Public property DisplayName The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public property DisplayNames 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.
Public property Id 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.

Public property ImmediateSubclassDefinitions Specifies a ClassDefinitionSet object, which contains a ClassDefinition object for each class that is an immediate subclass of the class defined by this ClassDefinition object.
Public property IsCBREnabled Specifies whether this class or property is enabled for full text indexing (content-based retrieval).

For classes, the following conditions apply:

  • The value of this property must be set to true if any property on this class is going to be enabled for CBR.
  • A value of true also enables full text indexing of any content associated with the class. (There is no content property to enable CBR.)

For properties, this property can be enabled only on Document, Annotation, CustomObject, and Folder objects.

Public property IsHidden Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).
Public property IsPersistent Specifies whether you can save the state of the object instantiation of this class (true) or not (false). If this property is false, only the server can save the state of the object.
Public property IsSystemOwned Indicates whether a given class or property was originally created by the Content Engine (true), as opposed to user-created (false).
Public property LastModifier 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).

Public property Name 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.

Public property Owner Manages the security owner assigned to the object.
Public property Permissions Manages the discretionary permissions assigned to the object.
Public property PropertyDefinitions Specifies a PropertyDefinitionList object containing an ordered collection of all of the property definitions belonging to this class definition.
Public property ProtectedPropertyCount Specifies the number of property definitions that can neither be moved nor removed from this class definition.
Public property SuperclassDefinition Specifies the ClassDefinition object that defines the immediate superclass of the class defined by this class definition.
Public property SymbolicName Represents 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), 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.

Public property TableDefinition The TableDefinition object for the database table in which this ClassDefinition or PropertyDefinition object resides.
Public property WorkflowSubscriptions The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object.
Top

See Also