|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use com.filenet.api.constants | |
---|---|
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.util | Provides utility classes and interfaces. |
Classes in com.filenet.api.constants used by com.filenet.api.action | |
---|---|
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. |
|
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 | |
---|---|
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. |
|
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). |
|
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. |
|
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. |
|
IndexJobStatus
Identifies the current status of an indexing job. |
|
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. |
|
RenditionEngineState
Provides a set of constants that identify the state of the Rendition Engine connection. |
|
ResourceStatus
Provides a set of constants that identify the availability status of a storage or index area. |
|
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.constants | |
---|---|
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. |
|
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, or content cache area. |
|
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). |
|
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. |
|
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. |
|
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. |
|
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. |
|
IndexJobStatus
Identifies the current status of an indexing job. |
|
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). |
|
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. |
|
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. |
|
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 an external class, which is represented by an ExternalClassDescription 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. |
|
SecurityPrincipalType
Identifies the type of the security principal--either a Group or User object. |
|
SecurityProxyType
Specifies the type of security proxy behavior associated with a given object-valued property. |
|
SpecialPrincipal
Exposes two special principal types as string constants: #AUTHENTICATED-USERS and
#CREATOR-OWNER . |
|
SystemAddOnId
Provides a set of GUID constants that identify the AddOns provided by the system. |
|
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. |
|
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. |
Classes in com.filenet.api.constants used by com.filenet.api.core | |
---|---|
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. |
|
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. |
|
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. |
|
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. |
|
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 | |
---|---|
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 | |
---|---|
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 (as defined by the document’s associated document lifecycle policy) or its exception-state status. |
Classes in com.filenet.api.constants used by com.filenet.api.meta | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 | |
---|---|
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. |
Classes in com.filenet.api.constants used by com.filenet.api.replication | |
---|---|
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 an external class, which is represented by an ExternalClassDescription 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. |
|
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 | |
---|---|
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--either a Group or User object. |
Classes in com.filenet.api.constants used by com.filenet.api.util | |
---|---|
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. |
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |