Package com.filenet.api.constants
Provides classes defining collections of related, type-safe constant values.
See: Description
-
Class Summary Class Description AccessLevel Deprecated As of release 5.2.0.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 givenAccessPermission
objectAddOnType 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, or content cache area.AuditLevel Provides a set of constants to enable or disable auditing on anObjectStore
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).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 aChoice
object represents.ClassNames Contains a constant for the name of each class in the FileNet P8 Content Engine API.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.ContainmentName Specifies illegal containment name characters.ContentAccessRecordingLevel Specifies options for the recording granularity of updates to the DateContentLastAccessed property when content is accessed.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 theSecurityFolder
property of the object referenced by theReferentialContainmentRelationship
object'sHead
property is set to theFolder
object referenced by theReferentialContainmentRelationship
object'sTail
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.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.GuidConstants Provides a set of constants representing GUID values for Content Engine API classes and properties.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 aCmIndexRequest
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 anIndexJob
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.PropertyNames Contains a constant for the name of each property in the FileNet P8 Content Engine API.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 aProperty
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.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.RetentionConstants Provides a set of constants for specifying special retention period values for a CmRetentionDate or DefaultRetentionPeriod property.RetentionPeriod Deprecated As of release 5.2.0.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 for Stored Search queries.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 aCmTask
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 (inTraceLoggingConfiguration
) 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 aVersioningSecurityTemplate
object to indicate the version state to which a given security template applies.Weekday Provides constants used to set the Weekday property of aCmTimeslot
object.
Package com.filenet.api.constants Description
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.