Uses of Package
com.filenet.api.constants

Packages that use com.filenet.api.constants

Package	Description
com.filenet.api.action	Provides classes that are related to making changes to objects.
com.filenet.api.admin	Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server.
com.filenet.api.constants	Provides classes defining collections of related, type-safe constant values.
com.filenet.api.core	Provides classes and interfaces that are related to the core business objects of the API, such as EntireNetwork, Domain, Document, Folder, and so on.
com.filenet.api.engine	Provides interfaces and classes related to EventActions and other non-FileNet code which runs within the Content Engine itself.
com.filenet.api.events	Provides interfaces that represent events triggered on Content Engine objects, as well as interfaces that allow you to extend Content Engine functionality and invoke it through the event mechanism.
com.filenet.api.meta	Provides interfaces for holding immutable metadata for Content Engine classes (class descriptions) and properties (property descriptions).
com.filenet.api.property	Provides classes and interfaces related to Content Engine object properties.
com.filenet.api.publishing	Provides interfaces related to publishing.
com.filenet.api.query	Provides classes related to constructing and performing Content Engine searches.
com.filenet.api.replication	Provides interfaces for defining objects that can be replicated and external repositories that are capable of federating content.
com.filenet.api.security	Provides interfaces related to authentication, authorization, and user- and group-specific data.
com.filenet.api.sweep	Provides classes and interfaces for the sweep framework, a background service that visits a specified class and processes the instances that meet a specified criteria.
com.filenet.api.util	Provides utility classes and interfaces.

Classes in com.filenet.api.constants used by com.filenet.api.action

Class and Description
LifecycleChangeFlags Provides a set of constants that specify how to change a document�s current lifecycle state or exception-state status, or an task's current state or exception-state status.
ReservationType Provides a set of constants that specify the type of reservation created for a checked-out document.

Classes in com.filenet.api.constants used by com.filenet.api.admin

Class and Description
AddOnType Provides a set of constants that identify whether the installation of an add-on is optional or recommended.
AreaDeleteMethod 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.
CachedContentOption Defines settings for determining when or if a content cache can be utilized for a particular storage area.
CacheStatus Defines settings for enabling or disabling a cache area for active use.
Cardinality 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).
CBRPropagationType This constant class is not supported.
ChoiceType Provides a set of constants that specify the type of data that a Choice object represents.
DatabaseType Provides a set of constants that identify the type of database used by a rendition engine or database storage area.
DeletionAction 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.
DeviceRetentionMode Specifies the retention mode of a fixed storage area relative to a fixed content device.
DirectoryStructure 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.
DurationUnits Provides a set of constants for setting the RetentionPeriodUnits property.
EventExporterType 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.
IndexingOperation Provides a set of constants that are used by the IndexingOperation property of a CmIndexRequest object to identify the type of index request operation.
IndexingStatus Provides a set of constants that specify the load balancing status of an IBM® Content Search Services index.
IndexJobStatus Provides a set of constants that are used by the JobStatus property of an IndexJob object to identify the status of an index job.
IndexRequestStatus Indicates the status of an index request.
InstallationStatus Provides a set of constants that identify the status of an add-on installation or upgrade.
ObjectStateRecordingLevel Specifies the audit recording level of the source object for an event of type ObjectChangeEvent.
PropertyPersistence Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).
PropertySettability Provides a set of constants that specify when the value of a property can be set.
QueueEntryStatus Provides a set of read-only constants that specify the status of the queue-related operation.
RenditionEngineState Provides a set of constants that identify the state of the Rendition Engine connection.
ReplicaSynchronizationType The replication settings that determine how and in what order content is uploaded to advanced storage devices, as set on CmStorageDeviceConnection or CmReplicaSynchronizationSiteSettings.
ResourceStatus Provides a set of constants that specify the availability status of an index area, index, or storage area.
SecurityProxyType Specifies the type of security proxy behavior associated with a given object-valued property.
SortOrder Specifies the sort order.
TextSearchServerMode Provides a set of constants that identify the usage mode of the IBM® Content Search Services server.
TextSearchServerStatus Provides a set of constants that identify the status of the IBM® Content Search Services server.
TypeID Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold.
Weekday Provides constants used to set the Weekday property of a CmTimeslot object.

Classes in com.filenet.api.constants used by com.filenet.api.constants

Class and Description
AccessLevel Deprecated. As of release 5.2.0. Use a combination of AccessRight constants.
AccessRight Provides a set of constants that identify individual permissions (access rights) that can be applied to an object.
AccessType Specifies the security access (allow or deny) that a user has for a given AccessPermission object
AddOnType Provides a set of constants that identify whether the installation of an add-on is optional or recommended.
AreaDeleteMethod 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.
AuditLevel Provides a set of constants to enable or disable auditing on an ObjectStore object.
AutoClassify Provides a set of constants that indicates whether a document will be auto-classified during check-in.
AutoUniqueName Specifies whether naming collisions are to be detected and automatically resolved for containment names.
CachedContentOption Defines settings for determining when or if a content cache can be utilized for a particular storage area.
CacheStatus Defines settings for enabling or disabling a cache area for active use.
Cardinality 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).
CBRPropagationType This constant class is not supported.
CBRQueryOptimization Provides a set of constants for enabling or disabling dynamic switching optimization, as set on the CBRQueryOptimization property.
CBRQueryRankOverride Provides a set of constants for specifying rank ordering behavior for CBR (content-based retrieval) queries that request rank order.
CBRSearchType Provides a set of constants that indicate the type of full-text indexing subsystem, if any, that is enabled for the object store.
CBRSummaryType This class is not supported.
CheckinType Provides a set of constants to specify whether to check in a document reservation as a new minor or new major version.
ChoiceType Provides a set of constants that specify the type of data that a Choice object represents.
ComponentCascadeDeleteAction 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.
ComponentPreventDeleteAction Defines settings for the delete behavior of parent and child components within a compound document.
ComponentRelationshipType Defines settings that determine the type of compound document relationship between a child document and a parent document.
CompoundDocumentState Defines settings that identify whether a document is a standard document or a parent component in a compound document.
ConfigurationParameter Specifies the parameters that can be used when configuring the Content Engine API.
ConnectionType Provides the implementation of type-safe enumeration objects that identify the connection type between the client and the Content Engine server.
ContentAccessRecordingLevel Specifies options for the recording granularity of updates to the DateContentLastAccessed property when content is accessed.
ContentIntegrityOption Provides a set of constants that specify how content validation is performed on a storage area.
ContentQueryOptimization Specifies the content query optimization for a Stored Search query.
DatabaseType Provides a set of constants that identify the type of database used by a rendition engine or database storage area.
DefineSecurityParentage Exposes constants that indicate 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.
DeletionAction 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.
DeviceRetentionMode Specifies the retention mode of a fixed storage area relative to a fixed content device.
DirectoryStructure 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.
DocClassificationStatus Provides a set of constants that specify the auto-classification status of a document.
DomainType Provides a set of constants to indicate the type of a domain.
DurationUnits Provides a set of constants for setting the RetentionPeriodUnits property.
EventExporterType 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.
FilteredPropertyType 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.
GroupAction Specifies the type of group action to apply to a set of content terms in a Stored Search query.
IndexingFailureCode 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.
IndexingFailureRecordingLevel Identifies whether or how indexing failures are persisted to the object store.
IndexingOperation Provides a set of constants that are used by the IndexingOperation property of a CmIndexRequest object to identify the type of index request operation.
IndexingStatus Provides a set of constants that specify the load balancing status of an IBM® Content Search Services index.
IndexJobStatus Provides a set of constants that are used by the JobStatus property of an IndexJob object to identify the status of an index job.
IndexRequestStatus Indicates the status of an index request.
InstallationStatus Provides a set of constants that identify the status of an add-on installation or upgrade.
JoinComparison Specifies the operation to use when comparing the constituents of a SQL join operation (the constituents of the ON clause in a SQL statement).
JoinOperator Specifies the type of join to use when querying multiple class instances (tables).
JoinType Specifies the join type for a Stored Search query.
LifecycleChangeFlags Provides a set of constants that specify how to change a document�s current lifecycle state or exception-state status, or an task's current state or exception-state status.
MergeMode Determines how the search results are merged for searches across multiple repositories.
ObjectStateRecordingLevel Specifies the audit recording level of the source object for an event of type ObjectChangeEvent.
PermissionSource Specifies the source of a given access permission.
PermissionType Specifies the type of permission.
PrincipalSearchAttribute Determines which (if any) identifying attribute is used for a specified search pattern.
PrincipalSearchSortType Determines which (if any) sorting is applied to the results of a specified search pattern.
PrincipalSearchType Determines which (if any) pattern-matching is used for a specified search pattern.
PropertyPersistence Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).
PropertySettability Provides a set of constants that specify when the value of a property can be set.
PropertyState 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.
PublicationStatus Provides a set of constants that identify the publication status of a document.
PublishingStatus Provides a set of constants that identify the status of a publish request.
QueueEntryStatus Provides a set of read-only constants that specify the status of the queue-related operation.
RefreshMode 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.
RenditionEngineState Provides a set of constants that identify the state of the Rendition Engine connection.
ReplicaSynchronizationType The replication settings that determine how and in what order content is uploaded to advanced storage devices, as set on CmStorageDeviceConnection or CmReplicaSynchronizationSiteSettings.
ReplicationDirection 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.
ReplicationJournalStatus A set of constants that specifies the processing status of a replication journal entry.
ReplicationMode Provides a set of constants that specify the replication mode of the object store or external repository participant.
RequiredState Specifies the possible required states for Stored Search queries.
ReservationType Provides a set of constants that specify the type of reservation created for a checked-out document.
ResourceStatus Provides a set of constants that specify the availability status of an index area, index, or storage area.
SearchModifier Specifies search modifiers for Stored Search queries.
SecurityPrincipalType Identifies the type of the security principal.
SecurityProxyType Specifies the type of security proxy behavior associated with a given object-valued property.
SortOrder Specifies the sort order.
SpecialPrincipal Exposes two special principal types as string constants: #AUTHENTICATED-USERS and #CREATOR-OWNER.
SweepMode Provides a set of constants for setting the execution mode of a sweep job or policy.
SweepResultType Provides a set of constants that identify the the type of sweep result record.
SystemAddOnId Provides a set of GUID constants that identify the AddOns provided by the system.
TaskState Provides a set of constants that identify the states of a CmTask object.
TextSearchServerMode Provides a set of constants that identify the usage mode of the IBM® Content Search Services server.
TextSearchServerStatus Provides a set of constants that identify the status of the IBM® Content Search Services server.
ThumbnailImageColor Provides a set of constants for setting the color of images rendered by the thumbnail generation service.
ThumbnailImageFormat Provides a set of constants for setting the bitmap format of images rendered by the thumbnail generation service.
ThumbnailImageSize Provides a set of constants for setting the size of images rendered by the thumbnail generation service.
TraceFlag Contains the trace logging settings used to configure trace logging (in TraceLoggingConfiguration) for the supported subsystems.
TypeID Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold.
VersionBindType Defines settings for version bind rules.
VersionSelection Specifies the document version that will be included in a Stored Search query.
VersionStatus Provides a set of constants that allow the server to specify the current version state of a document version.
VersionStatusId 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.
Weekday Provides constants used to set the Weekday property of a CmTimeslot object.

Classes in com.filenet.api.constants used by com.filenet.api.core

Class and Description
AuditLevel Provides a set of constants to enable or disable auditing on an ObjectStore object.
AutoClassify Provides a set of constants that indicates whether a document will be auto-classified during check-in.
AutoUniqueName Specifies whether naming collisions are to be detected and automatically resolved for containment names.
CBRQueryOptimization Provides a set of constants for enabling or disabling dynamic switching optimization, as set on the CBRQueryOptimization property.
CBRQueryRankOverride Provides a set of constants for specifying rank ordering behavior for CBR (content-based retrieval) queries that request rank order.
CBRSearchType Provides a set of constants that indicate the type of full-text indexing subsystem, if any, that is enabled for the object store.
CBRSummaryType This class is not supported.
CheckinType Provides a set of constants to specify whether to check in a document reservation as a new minor or new major version.
ComponentCascadeDeleteAction 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.
ComponentPreventDeleteAction Defines settings for the delete behavior of parent and child components within a compound document.
ComponentRelationshipType Defines settings that determine the type of compound document relationship between a child document and a parent document.
CompoundDocumentState Defines settings that identify whether a document is a standard document or a parent component in a compound document.
ConfigurationParameter Specifies the parameters that can be used when configuring the Content Engine API.
ConnectionType Provides the implementation of type-safe enumeration objects that identify the connection type between the client and the Content Engine server.
ContentAccessRecordingLevel Specifies options for the recording granularity of updates to the DateContentLastAccessed property when content is accessed.
DatabaseType Provides a set of constants that identify the type of database used by a rendition engine or database storage area.
DefineSecurityParentage Exposes constants that indicate 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.
DocClassificationStatus Provides a set of constants that specify the auto-classification status of a document.
DomainType Provides a set of constants to indicate the type of a domain.
IndexingFailureRecordingLevel Identifies whether or how indexing failures are persisted to the object store.
LifecycleChangeFlags Provides a set of constants that specify how to change a document�s current lifecycle state or exception-state status, or an task's current state or exception-state status.
PublicationStatus Provides a set of constants that identify the publication status of a document.
RefreshMode 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.
ReservationType Provides a set of constants that specify the type of reservation created for a checked-out document.
TaskState Provides a set of constants that identify the states of a CmTask object.
VersionBindType Defines settings for version bind rules.
VersionStatus Provides a set of constants that allow the server to specify the current version state of a document version.

Classes in com.filenet.api.constants used by com.filenet.api.engine

Class and Description
PrincipalSearchAttribute Determines which (if any) identifying attribute is used for a specified search pattern.
PrincipalSearchSortType Determines which (if any) sorting is applied to the results of a specified search pattern.

Classes in com.filenet.api.constants used by com.filenet.api.events

Class and Description
AuditLevel Provides a set of constants to enable or disable auditing on an ObjectStore object.
LifecycleChangeFlags Provides a set of constants that specify how to change a document�s current lifecycle state or exception-state status, or an task's current state or exception-state status.

Classes in com.filenet.api.constants used by com.filenet.api.meta

Class and Description
Cardinality 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).
DeletionAction 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.
PropertyPersistence Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).
PropertySettability Provides a set of constants that specify when the value of a property can be set.
SecurityProxyType Specifies the type of security proxy behavior associated with a given object-valued property.
TypeID Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold.

Classes in com.filenet.api.constants used by com.filenet.api.property

Class and Description
FilteredPropertyType 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.
PropertyState 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.

Classes in com.filenet.api.constants used by com.filenet.api.publishing

Class and Description
PublishingStatus Provides a set of constants that identify the status of a publish request.

Classes in com.filenet.api.constants used by com.filenet.api.query

Class and Description
ContentQueryOptimization Specifies the content query optimization for a Stored Search query.
GroupAction Specifies the type of group action to apply to a set of content terms in a Stored Search query.
JoinComparison Specifies the operation to use when comparing the constituents of a SQL join operation (the constituents of the ON clause in a SQL statement).
JoinOperator Specifies the type of join to use when querying multiple class instances (tables).
MergeMode Determines how the search results are merged for searches across multiple repositories.
RequiredState Specifies the possible required states for Stored Search queries.
SearchModifier Specifies search modifiers for Stored Search queries.
SortOrder Specifies the sort order.
VersionSelection Specifies the document version that will be included in a Stored Search query.

Classes in com.filenet.api.constants used by com.filenet.api.replication

Class and Description
Cardinality 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).
ReplicationDirection 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.
ReplicationJournalStatus A set of constants that specifies the processing status of a replication journal entry.
ReplicationMode Provides a set of constants that specify the replication mode of the object store or external repository participant.
TypeID Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold.

Classes in com.filenet.api.constants used by com.filenet.api.security

Class and Description
AccessType Specifies the security access (allow or deny) that a user has for a given AccessPermission object
PermissionSource Specifies the source of a given access permission.
PermissionType Specifies the type of permission.
PrincipalSearchAttribute Determines which (if any) identifying attribute is used for a specified search pattern.
PrincipalSearchSortType Determines which (if any) sorting is applied to the results of a specified search pattern.
PrincipalSearchType Determines which (if any) pattern-matching is used for a specified search pattern.
SecurityPrincipalType Identifies the type of the security principal.

Classes in com.filenet.api.constants used by com.filenet.api.sweep

Class and Description
DurationUnits Provides a set of constants for setting the RetentionPeriodUnits property.
SweepMode Provides a set of constants for setting the execution mode of a sweep job or policy.
SweepResultType Provides a set of constants that identify the the type of sweep result record.
ThumbnailImageColor Provides a set of constants for setting the color of images rendered by the thumbnail generation service.
ThumbnailImageFormat Provides a set of constants for setting the bitmap format of images rendered by the thumbnail generation service.
ThumbnailImageSize Provides a set of constants for setting the size of images rendered by the thumbnail generation service.

Classes in com.filenet.api.constants used by com.filenet.api.util

Class and Description
ConfigurationParameter Specifies the parameters that can be used when configuring the Content Engine API.
DatabaseType Provides a set of constants that identify the type of database used by a rendition engine or database storage area.