The IAddOn type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AddOnType |
Specifies whether the addon is optional or recommended for installation into an object store.
During object store creation, Administration Console for Content Platform Engine selects for installation those addons
having a type of recommended. Therefore, you should define an addon as recommended
only if the functionality it provides is very likely to be required in most installations. The
majority of addons should be defined as optional and must be explicitly selected for
installation. Note that although the default Administration Console behavior is to install
recommended addons, this is not required; you can deselect a recommended addon
if you do not need the functionality it provides.
|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | 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. |
![]() | DateCreated |
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. |
![]() | DateLastModified |
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). |
![]() | DescriptiveText |
User-readable text that describes an object.
The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | DisplayName |
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. |
![]() | 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:
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. |
![]() | 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). |
![]() | Prerequisites |
Specifies a list of IDs corresponding to the prerequisite add-ons that must be installed prior to the
installation of this add-on or upgrade add-on.
|
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ScriptType |
Specifies the language in which the pre- or post-import scripts are written. This property's
value must be set to JavaScript.
|
![]() | SupersededAddOnIds |
The IDs of IAddOn objects superseded by this IAddOn.
Although present on the IAddOn object and, by inheritance, the IUpgradeAddOn object, this property has no use on the IUpgradeAddOn object.. A newer version IAddOn must specify in this property the IDs of the prior version IAddOn objects that it functionally replaces, allowing an application with a dependency on that replaced (superseded) functionality to determine whether the functionality is available through the superseding IAddOn. (See also the IsAddOnInstalled helper method.) |