Provides classes defining collections of related, type-safe constant values. The class name identifies the purpose of the enumeration and the names of individual values identify their uses. For example, the CheckinType class contains MAJOR_VERSION and MINOR_VERSION constants identifying the checkin type as a major version or a minor version, respectively.

ToggleClasses

Type ClassDescription
Public classClassNames
Contains a constant for the name of each class in the FileNet P8 Content Engine API. Use these constants to supply the class name to methods, such as when calling CreateInstance on a Factory class. For example:

document = Factory.Document.CreateInstance(objectStore1, ClassNames.DOCUMENT);

Public classContainmentName
Specifies illegal containment name characters.

The Content Engine disallows certain characters in containment names. This constant is a String consisting of one each of those characters. The value of this constant is: \ / : * ? " < > |

Use this constant to validate an explicit containment name before supplying the name to various methods (such as File).

Public classFilteredPropertyType
Provides a set of constants that are used by a property filter to indicate the type of Content Engine properties to be retrieved during an object retrieval or an object refresh.
Public classGuidConstants
Provides a set of constants representing GUID values for Content Engine API classes and properties.
Public classJoinComparison
Specifies the operation to use when comparing the constituents of a SQL join operation (the constituents of the ON clause in a SQL statement).

This class is used by SearchSQL.SetFromClauseAdditionalJoin to construct a join.

Public classPropertyNames
Contains a constant for the name of each property in the FileNet P8 Content Engine API. Use these constants to supply the property name to methods, such as when calling AddIncludeProperty to add a filter element to a property filter. For example:

PropertyFilter pf = new PropertyFilter(); 
            pf.AddIncludeProperty(10, null, null, PropertyNames.SYMBOLIC_NAME);

Public classRetentionConstants
Provides a set of constants for specifying special retention period values for a CmRetentionDate or DefaultRetentionPeriod property.
Public classSpecialPrincipal
Exposes two special principal types as string constants: #AUTHENTICATED-USERS and #CREATOR-OWNER. These principal types are not real directory service entities; they represent special pseudo-accounts.

The #AUTHENTICATED-USERS pseudo-account is a logical group, all of whose members are authenticated users.

The #CREATOR-OWNER principal is the pseudo-account granted to the user who creates an object. It is a placeholder for the future owner of an object. A specific set of permissions (ACL) is defined for this account. These permissions provide full control over the created object. When the ACL is actually used, the real identity of the user accessing the object is substituted and becomes the actual owner ID. This occurs in the following instances:

  • When security templates are applied.
  • When an object inherits security from a parent.
  • When a security descriptor is initialized from the class's default instance security. An exception to this rule is when the object's DefaultInstanceOwner property is set to Null, in which case permissions from the default instance security that specify #CREATOR-OWNER as the grantee are ignored and not copied to the Permissions collection of the created object.
Public classSystemAddOnId
Provides a set of GUID constants that identify the AddOns provided by the system.
Public classVersionStatusId
Provides a set of GUID-string constants that are used by the ApplyStateID property of a VersioningSecurityTemplate object to indicate the version state to which a given security template applies.

ToggleEnumerations

Type EnumerationDescription
Public enumerationAccessLevel
Provides a set of commonly used combinations of access rights for simplifying presentation of access rights in a user interface (UI). Alternatively, you can use the I AccessPermissionDescription interface for presenting access levels and access rights in a UI. Unlike this interface, the IAccessPermissionDescription interface includes methods that provide descriptive information about access rights and access levels.

Access level definitions are subject to change. Do not use AccessLevel constants in non-interactive program logic for setting or checking permissions.

Public enumerationAccessRight
Provides a set of constants that identify individual permissions (access rights) that can be applied to an object. Access rights vary by object and control all operations on the object. A user's access to objects is controlled by the access rights awarded to the individual user, and by the access rights awarded to any group of which that user is a member. Access rights to individual objects are checked each time the user attempts to access an object from an object store.

Use AccessRight constants to set and check permissions. To determine which access rights are required to perform common actions, see Access rights required to take actions.

Public enumerationAccessType
Specifies the security access (allow or deny) that a user has for a given AccessPermission object.
Public enumerationAddOnType
Provides a set of constants that identify whether the installation of an add-on is optional or recommended.
Public enumerationAreaDeleteMethod
Provides a set of constants that identify the method used to delete content from a file storage area, fixed storage area, content cache area, or advanced storage device. For fixed content devices, deletion implementations depend on the device. If a fixed content device does not support one of the secure delete methods (that is, destructive or purge),
Public enumerationAuditLevel
Provides a set of constants to enable or disable auditing on an ObjectStore object.
Public enumerationAutoClassify
Provides a set of constants that indicates whether a document will be auto-classified during check-in.
Public enumerationAutoUniqueName
Specifies whether naming collisions are to be detected and automatically resolved for containment names. Containment names are set on ReferentialContainmentRelationship or DynamicReferentialContainmentRelationship objects.

If auto-unique naming is enabled, and a naming collision is detected, the containment name of the object is automatically appended with a suffix to make the name unique. For details, see the ContainmentName property.

CAUTION: Enabling auto-unique naming can have a severe performance impact when used for large numbers of objects filed in the same folder using a duplicate containment name. Under certain conditions, the Content Engine might retry the filing operation many times before the filing operation succeeds. In those cases, timeouts can occur. Therefore, your client application should ensure that unique containment names are created for each object, so that the auto-unique naming is only needed infrequently.

Public enumerationCachedContentOption
Defines settings for determining when or if a content cache can be utilized for a particular storage area.
Public enumerationCacheStatus
Defines settings for enabling or disabling a cache area for active use.
Public enumerationCardinality
Provides a set of constants that specify whether a property can hold a single value (single cardinality) or a collection of multiple values (list or enumeration cardinality).
Public enumerationCBRPropagationType
This constant class is not supported.
Public enumerationCBRQueryOptimization
Provides a set of constants for enabling or disabling dynamic switching optimization, as set on the CBRQueryOptimization property. Dynamic switching optimization applies to searches that combine both full text and relational query conditions.
Public enumerationCBRQueryRankOverride
Provides a set of constants for specifying rank ordering behavior for CBR (content-based retrieval) queries that request rank order. The constants are set on the CBRQueryRankOverride property.
Public enumerationCBRSearchType
Provides a set of constants that indicate the type of full-text indexing subsystem, if any, that is enabled for the object store.
Public enumerationCBRSummaryType
This class is not supported.
Public enumerationCheckinType
Provides a set of constants to specify whether to check in a document reservation as a new minor or new major version. During a minor version check-in, the new minor document version is marked as in-process (its VersionStatus property is set to IN_PROCESS) and the previous in-process minor document version (if it exists) is marked as superseded (its VersionStatus property is set to SUPERSEDED). During a major version check-in, the new major document version is marked as released (its VersionStatus property is set to RELEASED) and the previous released major document version and in-process minor document version (if they exist) are marked as superseded.
Public enumerationChoiceType
Provides a set of constants that specify the type of data that a Choice object represents. These constants are used in conjunction with the ChoiceType property to specify whether a given Choice object represents an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type Choice objects, or a group node for a nested collection of string-type Choice objects.
Public enumerationComponentCascadeDeleteAction
Defines settings for controlling the deletion of a child component as an automatic response to the deletion of the parent component within a compound document.
Public enumerationComponentPreventDeleteAction
Defines settings for the delete behavior of parent and child components within a compound document. The prevention settings protect a document from deletion by causing an exception to be thrown on a deletion attempt.
Public enumerationComponentRelationshipType
Defines settings that determine the type of compound document relationship between a child document and a parent document. For additional information on component relationship types, including the required properties you must set to create a new ComponentRelationship object of each type, see the ComponentRelationshipType property.
Public enumerationCompoundDocumentState
Defines settings that identify whether a document is a standard document or a parent component in a compound document.
Public enumerationConfigurationParameter
Specifies the parameters that can be used when configuring the Content Engine API.

This class provides a set of constants to specify values for:

  • Configuring connections to the IBM FileNet P8 domain.
  • Specifying client metadata cache (CMC) configuration options.

This class includes support for parsing configuration values. Comparisons and lookups are case-insensitive, so the case of string key equivalents is not significant.

This class also includes an array of valid types, such as {Integer.Class, Boolean.Class}, to assist you in parsing and validating parameter values. The list is Null if not applicable, or is dependent on the context of where the parameter is used. A non-null list always has a length of at least one.

To set parameter values, create an instance of ConfigurationParameters, call ConfigurationParameters.SetParameter, passing in the desired parameter values, and then call Configuration.Init. The code snippet below sets the block size for retrieving content:

            ConfigurationParameters parameters = new ConfigurationParameters();
            Object value = new Integer(64);
            parameters.SetParameter(ConfigurationParameter.CONTENT_GET_BLOCK_SIZE_KB, value);
            Configuration.Init(parameters);
            

Public enumerationContentAccessRecordingLevel
Specifies options for the recording granularity of updates to the DateContentLastAccessed property when content is accessed.

Note Whenever content access recording is enabled, system performance might be impacted. The impact increases as you increase recording frequency. For more information, see ContentAccessRecordingLevel Property.

Public enumerationContentIntegrityOption
Provides a set of constants that specify how content validation is performed on a storage area. The constants are set as a bitmask on the CmContentIntegrityOptions property of IStorageArea.

Content integrity options apply only to an advanced storage area.

See Advanced storage areas"

Public enumerationContentQueryOptimization
Specifies the content query optimization for a Stored Search query.
Public enumerationDatabaseType
Provides a set of constants that identify the type of database used by a rendition engine or database storage area.
Public enumerationDefineSecurityParentage
Exposes constants that specify whether the SecurityFolder property of the object referenced by the ReferentialContainmentRelationship object's Head property is set to the Folder object referenced by the ReferentialContainmentRelationship object's Tail property. Use these constants when calling the Folder.file method to add a new object to a folder, or when calling createInstance to create a ReferentialContainmentRelationship object.
Public enumerationDeletionAction
Provides a set of constants that identify the action to be taken with respect to an object-valued property when an attempt is made to delete the object that contains the property.
Public enumerationDeviceRetentionMode
Specifies the retention mode of a fixed storage area relative to a fixed content device. Both modes apply only to checked-in documents that have their content stored on a fixed content device.
Public enumerationDirectoryStructure
Provides a set of constants that identify the type of directory structure (large or small) used by a file storage area or content cache area.
Public enumerationDocClassificationStatus
Provides a set of constants that specify the auto-classification status of a document. These constants are used in conjunction with the ClassificationStatus property to provide client applications a means of discovering whether a particular document is subject to auto-classification, and if so, whether or not the operation was successful.
Public enumerationDomainType
Provides a set of constants to indicate the type of a domain. These constants are used in conjunction with the DomainType property of a Domain object to provide client applications a means of discovering the type of the domain: stand-alone, master, or tenant.
Public enumerationDurationUnits
Provides a set of constants for setting the RetentionPeriodUnits property. This property specifies the time unit in which the retention duration period (DefaultRetentionPeriod property of a class definition or RetentionDurationUpdate property of a retention update policy) is expressed.
Public enumerationEventExporterType
Provides a set of constants for setting the type of event export store to create, for either the Case Analyzer or Case History publishing service.

In IBM Content Foundation, Case Analyzer and Process Simulator are not supported.

Public enumerationGroupAction
Specifies the type of group action to apply to a set of content terms in a Stored Search query.
Public enumerationIndexingFailureCode
Provides a set of constants that identifies the types of failures that have occurred as a result of an index request for a CBR-enabled object. A constant identifying each type of indexing failure is added to the bitmask returned by the CmIndexingFailureCode property of the CBR-enabled object and its associated index request. If there are no indexing failures, the CmIndexingFailureCode property returns a value of zero.
Public enumerationIndexingFailureRecordingLevel
Identifies whether or how indexing failures are persisted to the object store.
Public enumerationIndexingOperation
Provides a set of constants that are used by the IndexingOperation property of a CmIndexRequest object to identify the type of operation of an index request.
Public enumerationIndexingStatus
Provides a set of constants that specify the load balancing status of an IBM® Content Search Services index. These constants are used by the IndexingStatus property of the index. The Content Engine server automatically reassigns an index to another IBM Content Search Services server, if necessary, to balance the indexing workload of the server.
Public enumerationIndexJobStatus
Provides a set of constants that are used by the JobStatus property of an IndexJob object to identify the status of an index job.
Public enumerationIndexRequestStatus
Indicates the status of an index request. The status value will be updated by the indexing process.
Public enumerationInstallationStatus
Provides a set of constants that identify the status of an add-on installation or upgrade.
Public enumerationJoinOperator
Specifies the type of join to use when querying multiple class instances (tables). This class is used when constructing SQL statements with the SearchSQL class. The join type and behavior is that of the corresponding ANSI/ISO SQL99-compliant joins.
Public enumerationJoinType
Specifies the join type for a Stored Search query.
Public enumerationLifecycleChangeFlags
Provides a set of constants that specify how to change a document’s current lifecycle state or its exception-state status, or a task's current state or exception-state status. These constants are used by the flags parameter of a document or a task's ChangeState method.
Public enumerationMergeMode
Determines how the search results are merged for searches across multiple repositories.

The merge mode can be either:

  • The intersection of all classes found(INTERSECTION). The search results will contain the classes occurring in every repository searched.
  • The union of all classes found (UNION). The search results will contain the classes occurring in any repository searched.

When the merge mode is UNION and a class or property is not found in any repository, the following occurs:

  • For classes, an inner join returns no rows, and an outer join returns nulls. Join types are specified in the JoinOperator class.
  • For properties, the property value is Null in a selection list or WHERE clause, and is omitted from an ORDER BY clause.
Public enumerationObjectStateRecordingLevel
Specifies the audit recording level of the source object for an event of type ObjectChangeEvent.
Public enumerationPermissionSource
Specifies the source of a given access permission.
Public enumerationPermissionType
Specifies the type of permission.
Public enumerationPrincipalSearchAttribute
Determines which (if any) identifying attribute is used for a specified search pattern.

This class is used by Realm.FindUsers and Realm.FindGroups.

Note: If the Content Engine's directory service provider is configured for IBM Virtual Member Manager(VMM)with IBM Connections integration, then search type support is limited to the following values: PrincipalSearchType.EXACT or PrincipalSearchType.PREFIX_MATCH.

Public enumerationPrincipalSearchSortType
Determines which (if any) sorting is applied to the results of a specified search pattern.

This class is used by Realm.FindUsers and Realm.FindGroups.

Public enumerationPrincipalSearchType
Determines which (if any) pattern-matching is used for a specified search pattern.

This class is used by Realm.FindUsers and Realm.FindGroups.

Public enumerationPropertyPersistence
Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).
Public enumerationPropertySettability
Provides a set of constants that specify when the value of a property can be set. These constants are used by the Settability property.
Public enumerationPropertyState
Provides a set of constants that indicates the type of value held by a Property object as it relates to a given Content Engine property.
Public enumerationPublicationStatus
Provides a set of constants that identify the publication status of a document.
Public enumerationPublishingStatus
Provides a set of constants that identify the status of a publish request.
Public enumerationQueueEntryStatus
Provides a set of read-only constants that specify the status of the queue-related operation. There is no constant that indicates a completion state. When an operation completes successfully, the item is removed from the queue.
Public enumerationRefreshMode
Specifies whether to retrieve refreshed data from the Content Engine server for updating an object's property cache when the object is explicitly saved or is committed to the persistent store as part of a batch.

Use this constant when calling methods that have a refresh parameter, such as Save and CreateUpdatingBatchInstance. Depending on the parameters of the method being called, you can either refresh all of the object's properties or, by specifying a property filter, refresh a subset of the object's properties.

Note Note:Note that you cannot refresh an object's property cache until the object has been created on the Content Engine server. Attempting to do so causes an API_SAVE_BEFORE_REFRESH exception to be thrown.
Public enumerationRenditionEngineState
Provides a set of constants that identify the state of the Rendition Engine connection.
Public enumerationReplicaSynchronizationType
The replication settings that determine how and in what order content is uploaded to advanced storage devices, as set on ICmStorageDeviceConnection or ICmReplicaSynchronizationSiteSettings.

See Replication configuration

Public enumerationReplicationDirection
Provides a set of constants that specify the direction in which instances of a class or values of a property can be replicated between a Content Engine object store and an external repository.
Public enumerationReplicationJournalStatus
A set of constants that specifies the processing status of a replication journal entry.
Public enumerationReplicationMode
Provides a set of constants that specify the replication mode of the object store or external repository participant. The replication mode determines how objects are replicated in a replication group. These constants are used by the ReplicationMode property of an ExternalParticipant or ObjectStoreParticipant object (base interface is ReplicationParticipant).
Public enumerationRequiredState
Specifies the possible required states for Stored Search queries.
Public enumerationReservationType
Provides a set of constants that specify the type of reservation created for a checked-out document.
Public enumerationResourceStatus
Provides a set of constants that specify the availability status of an index area, index, or storage area.
Public enumerationRetentionPeriod Obsolete.
Provides a set of constants for specifying special, non-positive RetentionPeriod property values.

The RetentionPeriod property specifies when a content element will expire, so that it can be deleted from a storage area object. A positive retention period value represents the number of minutes a content element must be retained.

Public enumerationSearchModifier
Specifies search modifiers for Stored Search queries.
Public enumerationSecurityPrincipalType
Identifies the type of the security principal.
Public enumerationSecurityProxyType
Specifies the type of security proxy behavior associated with a given object-valued property.
Public enumerationSortOrder
Specifies the sort order.
Public enumerationSweepMode
Provides a set of constants for setting the execution mode of a sweep job or policy.
Public enumerationSweepResultType
Provides a set of constants that identify the type of sweep result record.
Public enumerationTaskState
Provides a set of constants that identify the states of a ICmTask object. For a complete description of each state, see Task State Machine.
Public enumerationTextSearchServerMode
Provides a set of constants that identify the usage mode of the IBM® Content Search Services server. The usage mode specifies which tasks can be performed by an IBM Content Search Services server so that the work load can be balanced across multiple, task-dedicated servers.
Public enumerationTextSearchServerStatus
Provides a set of constants that identify the status of the IBM® Content Search Services server.
Public enumerationThumbnailImageColor
Provides a set of constants for setting the color of images rendered by the thumbnail generation service.

The thumbnail generation service does not convert between color, grayscale, and black and white. It renders a document thumbnail with the color, gray scale, or black and white as found in the input document. Therefore, these constant settings do not impact the output of the thumbnail generation service.

Public enumerationThumbnailImageFormat
Provides a set of constants for setting the bitmap format of images rendered by the thumbnail generation service.
Public enumerationThumbnailImageSize
Provides a set of constants for setting the size of images rendered by the thumbnail generation service.
Public enumerationTraceFlag
Contains the trace logging settings used to configure trace logging (in ITraceLoggingConfiguration) for the supported subsystems. Multiple trace flags can be ORed when configuring the subsystems.
Public enumerationTypeID
Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold. These constants are returned by the DataType property. When creating a choice list, you must set its DataType property to either LONG or STRING.
Public enumerationVersionBindType
Defines settings for version bind rules. These rules partly determine the version of the child component document bound with the parent component.
Public enumerationVersionSelection
Specifies the document version that will be included in a Stored Search query.
Public enumerationVersionStatus
Provides a set of constants that allow the server to specify the current version state of a document version. A document version can be an in-process (latest) minor version, a released (latest) major version, a reservation (checked-out) version, or a superseded minor or major version. These constants are returned by the VersionStatus property.
Public enumerationWeekday
Provides constants used to set the Weekday property of a ICmTimeslot object. The Weekday property specifies the day of the week that the audit disposition thread will run, as defined in a CmAuditingConfiguration object.