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.


Classes

  Class Description
Public class 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 CreateInstance on a Factory class. For example:
 Copy Code
document = Factory.Document.CreateInstance(objectStore1, ClassNames.DOCUMENT);
Public class ContainmentName 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 class FilteredPropertyType  
Public class GuidConstants Provides a set of constants representing GUID values for Content Engine API classes and properties.
Public class 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).

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

Public class 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 AddIncludeProperty to add a filter element to a property filter. For example:
 Copy Code
PropertyFilter pf = new PropertyFilter(); 
            pf.AddIncludeProperty(10, null, null, PropertyNames.SYMBOLIC_NAME);
Public class SpecialPrincipal 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 class SystemAddOnId Provides a set of GUID constants that identify the AddOns provided by the system.
Public class 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.

Enumerations

  Enumeration Description
Public enumeration AccessLevel Provides a set of commonly-used combinations of access rights for use when setting permissions.
Public enumeration 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.
Public enumeration AccessType Specifies the security access (allow or deny) that a user has for a given AccessPermission object.
Public enumeration AddOnType Provides a set of constants that identify whether the installation of an add-on is optional or recommended.
Public enumeration 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.
Public enumeration AuditLevel Provides a set of constants to enable or disable auditing on an ObjectStore object.
Public enumeration AutoClassify Provides a set of constants that indicates whether a document will be auto-classified during check-in.
Public enumeration AutoUniqueName 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 an integer in parentheses (such as "myDocument(2)"). Containment names are modified only when a naming collision is detected.

Public enumeration CachedContentOption Defines settings for determining when or if a content cache can be utilized for a particular storage area.
Public enumeration CacheStatus Defines settings for enabling or disabling a cache area for active use.
Public enumeration 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).
Public enumeration 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 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 enumeration ChoiceType 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 enumeration 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.
Public enumeration 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.
Public enumeration 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 ComponentRelationship object of each type, see the ComponentRelationshipType property.
Public enumeration CompoundDocumentState Defines settings that identify whether a document is a standard document or a parent component in a compound document.
Public enumeration 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:

  • 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:

 Copy Code
            ConfigurationParameters parameters = new ConfigurationParameters();
            Object value = new Integer(64);
            parameters.SetParameter(ConfigurationParameter.CONTENT_GET_BLOCK_SIZE_KB, value);
            Configuration.Init(parameters);
            
Public enumeration 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.

Public enumeration DatabaseType Provides a set of constants that identify the type of database used by a rendition engine or database storage area.
Public enumeration DefineSecurityParentage 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 enumeration 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.
Public enumeration 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.
Public enumeration DocClassificationStatus 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 enumeration 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).

Public enumeration InstallationStatus Provides a set of constants that identify the status of an add-on installation or upgrade.
Public enumeration JoinOperator 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. SearchSQL.SetFromClauseAdditionalJoinJoinComparison
Public enumeration 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 flags parameter of a document's ChangeState method.
Public enumeration MergeMode 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 enumeration ObjectStateRecordingLevel Specifies the audit recording level of the source object for an event of type ObjectChangeEvent.
Public enumeration PermissionSource Specifies the source of a given access permission.
Public enumeration PermissionType Specifies the type of permission.
Public enumeration PrincipalSearchAttribute Determines which (if any) identifying attribute is used for a specified search pattern.

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

Public enumeration PrincipalSearchSortType 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 enumeration PrincipalSearchType Determines which (if any) pattern-matching is used for a specified search pattern.

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

Public enumeration PropertyPersistence Provides a set of constants that specify whether a property can be made persistent (that is, have its state stored in a database).
Public enumeration PropertySettability 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 enumeration 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.
Public enumeration PublicationStatus Provides a set of constants that identify the publication status of a document.
Public enumeration PublishingStatus Provides a set of constants that identify the status of a publish request.
Public enumeration 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 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 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 enumeration RenditionEngineState Provides a set of constants that identify the state of the Rendition Engine connection.
Public enumeration ReplicationDirection Provides a set of constants that specify the direction in which instances of an external class, which is represented by an ExternalClassDescription object, can be replicated between a Content Engine object store and an external repository.
Public enumeration ReplicationJournalStatus This set of constants is not supported.
Public enumeration ReplicationMode This set of constants is not supported.
Public enumeration ReservationType Provides a set of constants that specify the type of reservation created for a checked-out document.
Public enumeration ResourceStatus Provides a set of constants that identify the availability status of a storage or index area.
Public enumeration RetentionPeriod 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 enumeration SecurityPrincipalType Identifies the type of the security principal--either a Group or User object.
Public enumeration SecurityProxyType Specifies the type of security proxy behavior associated with a given object-valued property.
Public enumeration TraceFlag 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 enumeration 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 DataType property. When creating a choice list, you must set its DataType property to either LONG or STRING.
Public enumeration VersionBindType Defines settings for version bind rules. These rules partly determine the version of the child component document bound with the parent component.
Public enumeration 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 VersionStatus property.