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
class contains
and
constants identifying the checkin type as a major version or a minor version, respectively.
Classes
Class | Description | |||||
---|---|---|---|---|---|---|
![]() |
ClassNames | 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 on a class. For example:
|
||||
![]() |
ContainmentName | Specifies illegal containment name characters. The Content Engine disallows certain characters in containment names. This constant is a Use this constant to validate an explicit containment name before supplying the name to various methods (such as |
||||
![]() |
FilteredPropertyType | |||||
![]() |
GuidConstants | Provides a set of constants representing GUID values for Content Engine API classes and properties. | ||||
![]() |
JoinComparison | Specifies the operation to use when comparing the constituents of a SQL join operation (the constituents of the clause in a SQL statement). This class is used by |
||||
![]() |
PropertyNames | 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 to add a filter element to a property filter. For example:
|
||||
![]() |
SpecialPrincipal | Exposes two special principal types as string constants: and . These principal types are not real directory service entities; they represent special pseudo-accounts. The The
|
||||
![]() |
SystemAddOnId | Provides a set of GUID constants that identify the AddOns provided by the system. | ||||
![]() |
VersionStatusId | Provides a set of GUID-string constants that are used by the property of a object to indicate the version state to which a given security template applies. |
Enumerations
Enumeration | Description | |||||
---|---|---|---|---|---|---|
![]() |
AccessLevel | Provides a set of commonly-used combinations of access rights for use when setting permissions. |
||||
![]() |
AccessRight | 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 that type of 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. | ||||
![]() |
AccessType | Specifies the security access (allow or deny) that a user has for a given 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, or content cache area. If a fixed content device does not support one of the secure delete methods (that is, destructive or purge), then the device's standard delete method is used. | ||||
![]() |
AuditLevel | Provides a set of constants to enable or disable auditing on an |
||||
![]() |
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. Containment names are set on or objects. If auto-unique naming is enabled, and a naming collision is detected, the containment name of the object is automatically appended with an integer in parentheses (such as "myDocument(2)"). Containment names are modified only when a naming collision is detected. |
||||
![]() |
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). | ||||
![]() |
CheckinType | 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 property is set to ) and the previous in-process minor document version (if it exists) is marked as superseded (its property is set to ). During a major version check-in, the new major document version is marked as released (its property is set to ) and the previous released major document version and in-process minor document version (if they exist) are marked as superseded. |
||||
![]() |
ChoiceType | Provides a set of constants that specify the type of data that a object represents. These constants are used in conjunction with the property to specify whether a given object represents an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type objects, or a group node for a nested collection of string-type objects. |
||||
![]() |
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. The prevention settings protect a document from deletion by causing an exception to be thrown on a deletion attempt. | ||||
![]() |
ComponentRelationshipType | 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 object of each type, see the |
||||
![]() |
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. This class provides a set of constants to specify values for:
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 { To set parameter values, create an instance of
|
||||
![]() |
ContentAccessRecordingLevel | 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. |
||||
![]() |
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 specify whether the property of the object referenced by the object's property is set to the object referenced by the object's property. Use these constants when calling the method to add a new object to a folder, or when calling to create a object. |
||||
![]() |
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. | ||||
![]() |
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. These constants are used in conjunction with the 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. |
||||
![]() |
IndexJobStatus | Identifies the current status of an indexing job. If an index job terminates abnormally for any reason, indexing data for some objects will be in two collections if either a base class or a collection is indexed. The index job for this collection or class should be resubmitted after the cause of the abnormal termination is corrected. Note: When an index job is aborted and either the index job does not include all subclasses of a base class, or the index job was for single item indexes, no duplicate index items exist because these types of index jobs perform individual object deletes from the collection (rather than deleting the entire collection at the end of a successfully completed index job). |
||||
![]() |
InstallationStatus | Provides a set of constants that identify the status of an add-on installation or upgrade. | ||||
![]() |
JoinOperator | Specifies the type of join to use when querying multiple class instances (tables). This class is used when constructing SQL statements with the |
||||
![]() |
LifecycleChangeFlags | Provides a set of constants that specify how to change a document’s current lifecycle state (as defined by the document’s associated document lifecycle policy) or its exception-state status. These constants are used by the parameter of a document's method. |
||||
![]() |
MergeMode | Determines how the search results are merged for searches across multiple repositories. The merge mode can be either:
When the merge mode is
|
||||
![]() |
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. This class is used by |
||||
![]() |
PrincipalSearchSortType | Determines which (if any) sorting is applied to the results of a specified search pattern. This class is used by |
||||
![]() |
PrincipalSearchType | Determines which (if any) pattern-matching is used for a specified search pattern. This class is used by |
||||
![]() |
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. These constants are used by the property. |
||||
![]() |
PropertyState | Provides a set of constants that indicates the type of value held by a 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. | ||||
![]() |
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. Use this constant when calling methods that have a
|
||||
![]() |
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 an external class, which is represented by an object, can be replicated between a Content Engine object store and an external repository. |
||||
![]() |
ReplicationJournalStatus | This set of constants is not supported. | ||||
![]() |
ReplicationMode | This set of constants is not supported. | ||||
![]() |
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 identify the availability status of a storage or index area. | ||||
![]() |
RetentionPeriod | Provides a set of constants for specifying special, non-positive property values. The |
||||
![]() |
SecurityPrincipalType | Identifies the type of the security principal--either a or object. |
||||
![]() |
SecurityProxyType | Specifies the type of security proxy behavior associated with a given object-valued property. | ||||
![]() |
TraceFlag | Contains the trace logging settings used to configure trace logging (in ) for the supported subsystems. Multiple trace flags can be ORed when configuring the 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. These constants are returned by the property. When creating a choice list, you must set its property to either or . |
||||
![]() |
VersionBindType | Defines settings for version bind rules. These rules partly determine the version of the child component document bound with the parent component. | ||||
![]() |
VersionStatus | 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 property. |