|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use EngineObject | |
---|---|
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.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.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.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. |
Uses of EngineObject in com.filenet.api.action |
---|
Methods in com.filenet.api.action that return EngineObject | |
---|---|
EngineObject |
PendingAction.getEngineObjectValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds. |
Methods in com.filenet.api.action with parameters of type EngineObject | |
---|---|
void |
PendingAction.putValue(java.lang.String name,
EngineObject v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
Uses of EngineObject in com.filenet.api.admin |
---|
Subinterfaces of EngineObject in com.filenet.api.admin | |
---|---|
interface |
AddOn
Represents a product extension to the core FileNet P8 Content Engine components. |
interface |
AddOnInstallationRecord
Represents a record that contains information pertaining to the installation of an add-on. |
interface |
AsyncProcessingConfiguration
Represents configuration data for asynchronous processing of events. |
interface |
AsyncUpgradeQueueItem
For internal use only. |
interface |
AuditDefinition
Represents a definition that specifies audit-event parameters. |
interface |
CenteraFixedContentDevice
Represents the description of an EMC Centera fixed content device. |
interface |
CenteraSiteSettings
Represents the configuration settings that can be overridden for the EMC Centera fixed content devices on the specified site. |
interface |
CFSImportAgentConfiguration
Configures the importer component of Content Federation Service (CFS). |
interface |
CFSSiteSettings
For a particular FileNet P8 site, configures the Content Federation Service (CFS). |
interface |
Choice
Represents a single choice item in a choice list that can be assigned to a property, or represents a group node for a nested collection of choice items within a choice list. |
interface |
ChoiceList
Represents a choice list in an object store. |
interface |
ClassDefinition
Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes. |
interface |
CmDirectoryConfigurationOID
Configuration object for Oracle Directory Server security provider. |
interface |
CMODApplicationGroup
Represents an IBM® Content Manager OnDemand (CMOD) application group that can be configured for content federation. |
interface |
CMODFixedContentDevice
Represents the description of an IBM® Content Manager OnDemand (CMOD) external fixed content storage device. |
interface |
CmTivoliManagementClass
A management class that represents a specific retention setting for an IBM® Tivoli® Storage Manager (TSM) server. |
interface |
CodeModule
Represents a user-implemented Java event handler that executes when an Action -based object's events are raised. |
interface |
ColumnDefinition
Represents the description of a column in a Content Engine database table. |
interface |
ContentCacheArea
Represents a file storage area that stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers. |
interface |
ContentCacheConfiguration
Defines the configuration for a content cache. |
interface |
ContentConfiguration
Configures the Content Management Subsystem. |
interface |
DatabaseStorageArea
Represents a storage area for content elements stored in the database. |
interface |
DirectoryConfiguration
Represents the base configuration object for all security providers and holds directory configuration data. |
interface |
DirectoryConfigurationAD
Represents the configuration object for the Active Directory security provider. |
interface |
DirectoryConfigurationAdam
Represents the configuration object for an ADAM or AD LDS security provider. |
interface |
DirectoryConfigurationCA
This interface is not supported. |
interface |
DirectoryConfigurationIBM
Represents the configuration object for an IBM Tivoli security provider. |
interface |
DirectoryConfigurationNovell
Represents the configuration object for a Novell eDirectory security provider. |
interface |
DirectoryConfigurationSunOne
Represents the configuration object for a SunOne security provider. |
interface |
DITARenditionEngineConnection
Represents site-specific connection data for a DITA Rendition Engine that is referenced by a publishing configuration. |
interface |
DocumentClassDefinition
Represents the class definition (mutable class metadata) of the Document class and its subclasses. |
interface |
DocumentClassificationQueueItem
Represents a pending (queued) document auto-classification request. |
interface |
EventClassDefinition
Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited. |
interface |
EventQueueItem
Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero. |
interface |
FileStorageArea
Represents a storage area for content elements stored in the file system. |
interface |
FixedContentDevice
Represents the base, abstract class for all classes relating to fixed content devices. |
interface |
FixedStorageArea
Represents a storage area for content elements stored in a fixed content device. |
interface |
GenericFixedContentDevice
Represents the description of a generic fixed content device. |
interface |
IICEFixedContentDevice
Represents an external fixed content device accessible via an instance of IBM Content Integrator (formerly known as Information Integrator Content Edition or IICE). |
interface |
ImageServicesClassDescription
Represents the description of an Image Services document class. |
interface |
ImageServicesImportAgentConfiguration
Represents configuration data for an Image Services import operation. |
interface |
ImageServicesPropertyDescription
Represents the description of an Image Services document class property. |
interface |
ImageServicesSiteSettings
Represents the configuration settings that can be overridden for the Image Services fixed content devices on the specified site. |
interface |
IMFixedContentDevice
Represents the description of a FileNet Image Services fixed content device. |
interface |
IndexArea
Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval. |
interface |
IndexJob
Initiates and tracks the status of a full text indexing operation. |
interface |
IndexJobClassItem
Identifies the class to be full text indexed. |
interface |
IndexJobCollectionItem
Identifies a Verity collection to be full text indexed. |
interface |
IndexJobItem
Indicates a particular item that is being full text indexed. |
interface |
IndexJobSingleItem
Identifies an object to be full text indexed. |
interface |
IsolatedRegion
Contains all of the connection information necessary to access the Process Engine isolated region. |
interface |
LocalizedString
Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template. |
interface |
PEConnectionPoint
Routes Process Engine requests to an isolated region ( IsolatedRegion instance). |
interface |
PropertyDefinition
Represents the base class for all property definition classes. |
interface |
PropertyDefinitionBinary
Represents the definition of a property that holds a binary value. |
interface |
PropertyDefinitionBoolean
Represents the definition of a property that holds a Boolean value. |
interface |
PropertyDefinitionDateTime
Represents the definition of a property that holds a DateTime value. |
interface |
PropertyDefinitionFloat64
Represents the definition of a property that holds a Double (Float64) value. |
interface |
PropertyDefinitionId
Represents the definition of a property that holds a GUID string value. |
interface |
PropertyDefinitionInteger32
Represents the definition of a property that holds an integer value. |
interface |
PropertyDefinitionObject
Represents the definition of a property that holds a Content Engine object value. |
interface |
PropertyDefinitionString
Represents the definition of a property that holds a string value. |
interface |
PropertyTemplate
Represents the base class for all property template classes. |
interface |
PropertyTemplateBinary
Represents a property template for creating PropertyDefinitionBinary objects,
which you can add to class definitions to create user-defined properties for holding binary values. |
interface |
PropertyTemplateBoolean
Represents a property template for creating PropertyDefinitionBoolean objects,
which you can add to class definitions to create user-defined properties for holding Boolean values. |
interface |
PropertyTemplateDateTime
Represents a property template for creating PropertyDefinitionDateTime objects,
which you can add to class definitions to create user-defined properties for holding DateTime values. |
interface |
PropertyTemplateFloat64
Represents a property template for creating PropertyDefinitionFloat64 objects,
which you can add to class definitions to create user-defined properties for holding Double (Float64) values. |
interface |
PropertyTemplateId
Represents a property template for creating PropertyDefinitionId objects,
which you can add to class definitions to create user-defined properties for holding GUID string values. |
interface |
PropertyTemplateInteger32
Represents a property template for creating PropertyDefinitionInteger32 objects,
which you can add to class definitions to create user-defined properties for holding integer values. |
interface |
PropertyTemplateObject
Represents a property template for creating PropertyDefinitionObject objects,
which you can add to class definitions to create user-defined properties for holding Content Engine object values. |
interface |
PropertyTemplateString
Represents a property template for creating PropertyDefinitionString objects,
which you can add to class definitions to create user-defined properties for holding string values. |
interface |
PublishingConfiguration
References the configuration data for a publishing operation. |
interface |
QueueItem
This class is the base class for all queue-related classes. |
interface |
RenditionEngineConnection
Represents site-specific connection data for a Rendition Engine that is referenced by a publishing configuration. |
interface |
ReplicableClassDefinition
Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated. |
interface |
ReplicationConfiguration
Represents configuration settings for the replication components of a server. |
interface |
SecurityPropagationQueueItem
Represents a pending (queued) execution of an asynchronous security propagation action on a target object. |
interface |
ServerCacheConfiguration
Defines configuration options for all server caches that do not have object store-specific characteristics. |
interface |
ServerInstance
Represents a single instance of a Java Virtual Machine (JVM) running in an application server. |
interface |
Site
Identifies a geographical area within a FileNet P8 domain. |
interface |
SiteSettings
Represents an abstract, dependent object that provides site-specific, configuration value overrides. |
interface |
SnapLockFixedContentDevice
Represents the description of a NetApp SnapLock fixed content device. |
interface |
StorageArea
Represents the physical storage location where content will be stored. |
interface |
StoragePolicy
Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria. |
interface |
SubscribableClassDefinition
Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited. |
interface |
SubsystemConfiguration
Represents a configuration object related to a particular subsystem or functional area that can be configured relative to a server hierarchy. |
interface |
TableDefinition
Represents the description of a Content Engine database table. |
interface |
TivoliFixedContentDevice
Represents the description of an IBM® Tivoli Storage Manager (TSM) fixed content device. |
interface |
TraceLoggingConfiguration
Configures and enables trace logging on the Content Engine host for the supported subsystems. |
interface |
UpgradeAddOn
Specifies how to upgrade a set of existing add-ons to a new set of add-ons. |
interface |
VerityCollection
Identifies the full text indexing information used for a particular base class and all of its subclasses. |
interface |
VerityDomainConfiguration
Contains the Verity configuration properties that are common to all servers in a domain. |
interface |
VerityIndexArea
Contains information about an index area that is specific to the Verity content-based retrieval engine. |
interface |
VerityServerConfiguration
Contains the Verity configuration data (properties) for a server instance. |
interface |
VersionableClassDefinition
Represents the parent of the DocumentClassDefinition class, which holds the class definition of a
Document class and its subclasses. |
interface |
VirtualServer
Represents a logical entity for managing a group of server instances. |
interface |
XMLPropertyMappingScript
Represents the definition of a Document subclass for defining XML property mapping scripts. |
Uses of EngineObject in com.filenet.api.core |
---|
Subinterfaces of EngineObject in com.filenet.api.core | |
---|---|
interface |
Annotation
Represents an annotation that can be applied to a document, folder, or custom object. |
interface |
ComponentRelationship
Defines a hierarchical relationship between two documents as components in a compound document. |
interface |
ContainmentRelationship
Models containment relationships. |
interface |
ContentElement
Represents the superclass for classes used to access document or annotation content data. |
interface |
ContentReference
Represents external content data that exists outside of an object store (and therefore outside the control of the Content Engine server), but to which an object store maintains a reference. |
interface |
ContentTransfer
Represents content data that is local to an object store and directly managed by the Content Engine server. |
interface |
CustomObject
Represents a general interface that can be subclassed. |
interface |
Document
Represents a single version of a document stored in an object store. |
interface |
Domain
Represents a collection of resources and services sharing the same Global Configuration Database (GCD). |
interface |
DynamicReferentialContainmentRelationship
Represents a dynamic relationship between two Containable subclasses: a container and the
current version of a Document . |
interface |
EntireNetwork
Represents the highest-level object in the Content Engine API object model. |
interface |
Folder
Represents a container that can hold other Containable subclasses, but cannot have content data
of its own. |
interface |
IndependentlyPersistableObject
Represents a persistable IndependentObject that you can directly create,
update, and delete. |
interface |
IndependentObject
Indicates objects that are independent. |
interface |
Link
Represents a relationship between two objects. |
interface |
ObjectStore
Represents a location in which folders, documents, and custom objects are stored, accessed, and managed on the Content Engine server. |
interface |
ReferentialContainmentRelationship
Represents a static relationship between two Containable subclasses: a container and a containee. |
interface |
Relationship
Represents the base class for binary relationships between independently persistable objects of an object store. |
interface |
VersionSeries
Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of the Versionable interface). |
interface |
WorkflowDefinition
Represents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. |
Uses of EngineObject in com.filenet.api.events |
---|
Subinterfaces of EngineObject in com.filenet.api.events | |
---|---|
interface |
Action
Represents an extensible, user-implemented action in response to an event triggered on a source object. |
interface |
ActionConsumer
Represents consumer of Action-based objects . |
interface |
AuditConfigurationEvent
Represents an event that occurs when the auditing configuration of an object store is changed. |
interface |
CancelCheckoutEvent
Represents an event that occurs when a reservation on a versionable object is canceled. |
interface |
ChangeClassEvent
Represents an event that occurs when the class of an object is changed. |
interface |
ChangeStateEvent
Represents an event that occurs when the lifecycle state of a Document object changes. |
interface |
CheckinEvent
Represents an event that occurs when a versionable object is checked in. |
interface |
CheckoutEvent
Represents an event that occurs when a versionable object is checked out. |
interface |
ClassifyCompleteEvent
Represents an event that occurs when a document has been auto-classified, that is, assigned a document class automatically during checkin. |
interface |
ClassSubscription
Represents a subscription for events generated by all objects of a particular class. |
interface |
ClassWorkflowSubscription
Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class. |
interface |
CreationEvent
Represents an event that occurs when an object instance of a class is created and saved. |
interface |
CustomEvent
Represents a user-defined custom event. |
interface |
DeletionEvent
Represents an event that occurs when an object is deleted from the object store. |
interface |
DemoteVersionEvent
Represents an event that occurs when a versionable object is demoted to a minor version. |
interface |
DocumentClassificationAction
Defines the content type and the server-side Java implementation that automatically classifies a document of the defined content type. |
interface |
DocumentLifecycleAction
Represents the actions to be taken when a document's lifecycle state is changed. |
interface |
DocumentLifecyclePolicy
Represents the lifecycle policy for a document. |
interface |
DocumentState
Represents a valid lifecycle state of a document lifecycle policy. |
interface |
Event
Represents a system or custom event that can be triggered on an Content Engine object or class of objects. |
interface |
EventAction
Represents the actions taken when a subscribed event fires. |
interface |
FileEvent
Represents an event that occurs when a folder has its file method called to file a
Containable object, for example, a Document
or CustomObject , or when the file is called to create a subfolder. |
interface |
FreezeEvent
Represents an event that occurs when the freeze method
of a Versionable object is successfully called. |
interface |
GetContentEvent
Represents an event that occurs when the content of a content-carrying object is retrieved. |
interface |
GetObjectEvent
Represents an event that occurs when an object is retrieved from the object store. |
interface |
InstanceSubscription
Represents a subscription for events generated by a single object instance of a particular class. |
interface |
InstanceWorkflowSubscription
Represents a subscription that initiates a workflow in response to events generated by a single object instance. |
interface |
LockEvent
Represents an event that occurs when the lock method is called to lock or update
an existing lock on a Document , CustomObject , or Folder
object. |
interface |
ObjectChangeEvent
Represents an event that occurs when the state of an object is changed. |
interface |
PromoteVersionEvent
Represents an event that occurs when a document is promoted or checked in as a major version. |
interface |
PublishCompleteEvent
Represents an event that occurs when a document-publishing request has completed. |
interface |
PublishRequestEvent
Represents an event that occurs when a request has been made to publish or republish a document. |
interface |
QueryEvent
Repesents an event that occurs whenever a database query is performed. |
interface |
RetrievalEvent
Represents an event that occurs when a Content Engine object or its content is retrieved or queried. |
interface |
SubscribedEvent
A SubscribedEvent object represents a system or custom event that applies to a
Subscription object. |
interface |
Subscription
Represents a request to execute an event action when an event is triggered on a target Content Engine object. |
interface |
TakeFederatedOwnershipEvent
Event reported when the takeFederatedOwnership
method is applied to a Document object. |
interface |
UnfileEvent
Represents an event that occurs when a folder has its unfile method called to remove (unfile) a
Containable object, for example, a Document or
Folder , or when the unfile method is called to delete a subfolder. |
interface |
UnlockEvent
Represents an event that occurs when the unlock method is called
on a Document , CustomObject , or Folder object. |
interface |
UpdateEvent
Represents an event that occurs when changes are made to an object's properties. |
interface |
UpdateSecurityEvent
Represents an event that occurs when the security of an object is changed. |
interface |
WorkflowEventAction
Represents a definition of the actions taken when a workflow is initiated via an event that is subscribed to by a workflow subscription. |
Uses of EngineObject in com.filenet.api.meta |
---|
Subinterfaces of EngineObject in com.filenet.api.meta | |
---|---|
interface |
ClassDescription
Represents the fixed description (immutable metadata) of a class. |
interface |
PropertyDescription
Represents the base class for all property description classes. |
interface |
PropertyDescriptionBinary
Represents the fixed description of a property that holds a binary value. |
interface |
PropertyDescriptionBoolean
Represents the fixed description of a property that holds a Boolean value. |
interface |
PropertyDescriptionDateTime
Represents the fixed description of a property that holds a DateTime value. |
interface |
PropertyDescriptionFloat64
Represents the fixed description of a property that holds a Double (Float64) value. |
interface |
PropertyDescriptionId
Represents the fixed description of a property that holds a GUID string value. |
interface |
PropertyDescriptionInteger32
Represents the fixed description of a property that holds an integer value. |
interface |
PropertyDescriptionObject
Represents the fixed description of a property that holds a Content Engine object value. |
interface |
PropertyDescriptionString
Represents the fixed description of a property that holds a string value. |
Methods in com.filenet.api.meta with parameters of type EngineObject | |
---|---|
ClassDescription |
MetadataCache.getClassDescription(EngineObject eo)
Returns the class description for a given object. |
boolean |
MetadataCache.objectIsOfClass(EngineObject eo,
java.lang.String classIdent)
Returns whether an object is instantiated from a class or subclass identified by a given class name or GUID string ( true ) or not (false ). |
Uses of EngineObject in com.filenet.api.property |
---|
Methods in com.filenet.api.property that return EngineObject | |
---|---|
EngineObject |
Property.getEngineObjectValue()
Returns the value held by the Content Engine property represented by this PropertyEngineObject object. |
EngineObject |
Properties.getEngineObjectValue(java.lang.String propertyName)
Locates a PropertyEngineObject property by name in this Properties
collection and returns the value it holds. |
Methods in com.filenet.api.property with parameters of type EngineObject | |
---|---|
void |
Properties.putValue(java.lang.String propertyName,
EngineObject value)
Creates or updates a PropertyEngineObject instance in this Properties
collection. |
void |
PropertyEngineObject.setValue(EngineObject val)
Sets the value of this Content Engine property. |
Uses of EngineObject in com.filenet.api.publishing |
---|
Subinterfaces of EngineObject in com.filenet.api.publishing | |
---|---|
interface |
PublishRequest
Represents a queued request to publish a document using a specified PublishTemplate object. |
interface |
PublishStyleTemplate
Represents the style template that defines how a source document will be transformed. |
interface |
PublishTemplate
Represents a template for publishing a document. |
Uses of EngineObject in com.filenet.api.replication |
---|
Subinterfaces of EngineObject in com.filenet.api.replication | |
---|---|
interface |
CMODRepository
Represents an IBM® Content Manager OnDemand (CMOD) external repository that is capable of federating content. |
interface |
ContentFederatingRepository
Represents repositories that are external to the Content Engine server and are capable of federating content. |
interface |
ExternalAlias
Represents the mechanism for mapping an external class or property to a corresponding Content Engine class or property. |
interface |
ExternalClassAlias
Represents the mechanism for mapping an external class to a corresponding Content Engine class. |
interface |
ExternalClassDescription
Represents the description of a class in an external repository of which an object instance can be replicated. |
interface |
ExternalIdentity
Represents the identity of a replicated object in an external repository. |
interface |
ExternalParticipant
This interface is not supported. |
interface |
ExternalPropertyAlias
Represents the mechanism for mapping an external class property to a corresponding Content Engine class property. |
interface |
ExternalPropertyDescription
Represents the description of a class property in an external repository. |
interface |
ExternalRepository
Represents repositories that are external to the Content Engine server. |
interface |
ImageServicesRepository
Represents an IBM® FileNet® Image Services external repository that is capable of federating content. |
interface |
ObjectStoreParticipant
Represents an object store participant of a replication group. |
interface |
ReplicationGroup
This interface is not supported. |
interface |
ReplicationJournalEntry
Represents the journal record of an operation on a replicated object for outbound replication. |
interface |
ReplicationParticipant
This interface is the base for subinterfaces representing external repository or object store participants in a replication group. |
interface |
Repository
This interface is the base for subinterfaces representing object stores and external repositories. |
Uses of EngineObject in com.filenet.api.security |
---|
Subinterfaces of EngineObject in com.filenet.api.security | |
---|---|
interface |
AccessPermission
Defines access permissions through a bitmask of access rights. |
interface |
AccessPermissionDescription
Describes an access right or level. |
interface |
ActiveMarking
Represents a marking that is currently applied to a given object. |
interface |
ApplicationSecurityTemplate
Represents a template through which an application can apply permissions (access rights) to a Document ,
CustomObject , or Folder object, and to their subclasses. |
interface |
DiscretionaryPermission
Base class for permission objects that define discretionary access permissions. |
interface |
Group
Represents a group of user accounts defined by the directory service on the Content Engine server. |
interface |
Marking
Represents the definition of a value that may be assigned to a marking-controlled property. |
interface |
MarkingSet
Represents a container for the set of markings for a given object property. |
interface |
Permission
Represents the base class for Permission objects. |
interface |
PermissionDescription
Base class for objects describing permissions. |
interface |
Realm
Consists of a set of related groups and users. |
interface |
SecurityPolicy
Represents an independently persistable, subclassable container for a list of security templates. |
interface |
SecurityPrincipal
Provides the base class for security principals ( Group and User objects). |
interface |
SecurityTemplate
Represents the base class for security template classes. |
interface |
User
Represents a particular user who has access to Content Engine resources. |
interface |
VersioningSecurityTemplate
Represents a template for automatically applying permissions (access rights) to a Document
object during versioning state changes. |
Uses of EngineObject in com.filenet.api.util |
---|
Methods in com.filenet.api.util with parameters of type EngineObject | |
---|---|
static byte[] |
Encryption.encrypt(EngineObject eo,
byte[] plainText)
Encrypts a byte array using the public key from the domain object associated with the given EngineObject . |
static byte[] |
Encryption.encrypt(EngineObject eo,
char[] plainText)
Encrypts the given char array using the public key from the Domain object associated with
the given EngineObject . |
static byte[] |
Encryption.encrypt(EngineObject eo,
java.lang.String plainText)
Encrypts the given string using the public key from the Domain object associated with the
given EngineObject . |
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |