com.filenet.api.core
Interface EngineObject
-
- All Superinterfaces:
- java.io.Serializable
- All Known Subinterfaces:
- AccessPermission, AccessPermissionDescription, Action, ActionConsumer, ActiveMarking, AddOn, AddOnInstallationRecord, Annotation, ApplicationSecurityTemplate, AsyncProcessingConfiguration, AsyncUpgradeQueueItem, AuditConfigurationEvent, AuditDefinition, CancelCheckoutEvent, CenteraFixedContentDevice, CenteraSiteSettings, CFSImportAgentConfiguration, CFSSiteSettings, ChangeClassEvent, ChangeStateEvent, CheckinEvent, CheckoutEvent, Choice, ChoiceList, ClassDefinition, ClassDescription, ClassifyCompleteEvent, ClassSubscription, ClassWorkflowSubscription, CmAbstractDependent, CmAbstractPermission, CmAbstractPersistable, CmAbstractQueueEntry, CmAbstractSearchResult, CmAbstractSequential, CmAdvancedStorageArea, CmAtmosFixedContentDevice, CmAuditDispositionPolicy, CmAuditingConfiguration, CmAuditProcessingBookmark, CmAWSFixedContentDevice, CmAzureBlobStorageDevice, CmBackgroundSearch, CmBulkMoveContentJob, CmChangePreprocessorAction, CmChangePreprocessorDefinition, CmContentBackoutQueueEntry, CmContentBackoutQueueSweep, CmContentConsistencyCheckJob, CmContentConversionAction, CmContentConversionConfiguration, CmContentConversionSettings, CmContentDeletionQueueEntry, CmContentDeletionQueueSweep, CmContentMigrationPolicy, CmContentReplicationQueueEntry, CmContentReplicationQueueSweep, CmConversionSettingsClassDefinition, CmCustomQueueSweep, CmCustomStorageDevice, CmCustomSweepJob, CmCustomSweepPolicy, CmDatabaseConnection, CmDelegatedAccessPermission, CmDependentClassDefinition, CmDirectoryConfigurationDomino, CmDirectoryConfigurationManaged, CmDirectoryConfigurationOID, CmDirectoryConfigurationRadiantOne, CmDirectoryConfigurationSCIM, CmDirectoryConfigurationVMM, CmDisposalPolicy, CmDynamicRole, CmElasticSearchCluster, CmElasticSearchIndex, CmElasticSearchIndexArea, CmElasticSearchIndexingSweep, CmElasticSearchIndexRequest, CmEventExportStore, CmExtendedPermission, CmFileSystemStorageDevice, CmHitachiFixedContentDevice, CmHold, CmHoldRelationship, CmICOSFixedContentDevice, CmIdentityRule, CmIndexDefinition, CmIndexedColumn, CmIndexJobResyncItem, CmIndexPartitionConstraint, CmIndexPartitionConstraintDate, CmIndexPartitionConstraintString, CmIndexRequest, CmIsilonFixedContentDevice, CmJobSweepResult, CmLocalGroup, CmLocalGroupMember, CmManagedUser, CmMarkForDeletionEvent, CmMoveContentEvent, CMODApplicationGroup, CMODFixedContentDevice, CMODRepository, CmOpenStackStorageDevice, CmPolicyControlledSweep, CmPolicySweepResult, CmProcessEngineConfiguration, CmQueueEntryClassDefinition, CmQueueSweep, CmRecoverEvent, CmRecoveryBin, CmRecoveryItem, CmReplicaSynchronizationSiteSettings, CmRetentionUpdateJob, CmRetentionUpdatePolicy, CmRole, CmRoleAccessDefinition, CmRoleClassDefinition, CmRoleMember, CmRoleMembershipAction, CmRolePermission, CmRolePrincipalMember, CmRoleRealmMember, CmRoleRoleMember, CmS3StorageDevice, CmSearchFunctionDefinition, CmSecuredStorageDevice, CmSMTPConfiguration, CmStaticRole, CmStorageDevice, CmStorageDeviceConnection, CmSweep, CmSweepAction, CmSweepConfiguration, CmSweepJob, CmSweepPolicy, CmSweepPolicyRelationship, CmSweepRelationship, CmSweepResult, CmTask, CmTaskRelationship, CmTextExtractionSettings, CmTextIndexingPreprocessorAction, CmTextIndexingPreprocessorDefinition, CmTextSearchAffinityGroup, CmTextSearchConfiguration, CmTextSearchIndex, CmTextSearchIndexArea, CmTextSearchIndexRequest, CmTextSearchPartitionDateProperty, CmTextSearchPartitionProperty, CmTextSearchPartitionStringProperty, CmTextSearchServer, CmThreadPoolConfiguration, CmThumbnail, CmThumbnailGenerationJob, CmThumbnailGenerationSubscription, CmThumbnailRequest, CmThumbnailRequestSweep, CmTimeslot, CmTivoliManagementClass, CodeModule, ColumnDefinition, ComponentRelationship, ContainmentRelationship, ContentCacheArea, ContentCacheConfiguration, ContentConfiguration, ContentElement, ContentFederatingRepository, ContentReference, ContentTransfer, CreationEvent, CustomEvent, CustomObject, DatabaseStorageArea, DeletionEvent, DemoteVersionEvent, DirectoryConfiguration, DirectoryConfigurationAD, DirectoryConfigurationAdam, DirectoryConfigurationCA, DirectoryConfigurationIBM, DirectoryConfigurationNovell, DirectoryConfigurationSunOne, DiscretionaryPermission, Document, DocumentClassDefinition, DocumentClassificationAction, DocumentClassificationQueueItem, DocumentLifecycleAction, DocumentLifecyclePolicy, DocumentState, Domain, DynamicReferentialContainmentRelationship, EntireNetwork, Event, EventAction, EventClassDefinition, EventQueueItem, ExternalAlias, ExternalClassAlias, ExternalClassDescription, ExternalIdentity, ExternalParticipant, ExternalPropertyAlias, ExternalPropertyDescription, ExternalRepository, FileEvent, FileStorageArea, FixedContentDevice, FixedStorageArea, Folder, FreezeEvent, GenericFixedContentDevice, GetContentEvent, GetObjectEvent, Group, IICEFixedContentDevice, ImageServicesClassDescription, ImageServicesImportAgentConfiguration, ImageServicesPropertyDescription, ImageServicesRepository, ImageServicesSiteSettings, IMFixedContentDevice, IndependentlyPersistableObject, IndependentObject, IndexArea, IndexJob, IndexJobClassItem, IndexJobCollectionItem, IndexJobItem, IndexJobSingleItem, InstanceSubscription, InstanceWorkflowSubscription, IsolatedRegion, Link, LocalizedString, LockEvent, Marking, MarkingSet, ObjectChangeEvent, ObjectStore, ObjectStoreParticipant, PEConnectionPoint, Permission, PermissionDescription, PromoteVersionEvent, PropertyDefinition, PropertyDefinitionBinary, PropertyDefinitionBoolean, PropertyDefinitionDateTime, PropertyDefinitionFloat64, PropertyDefinitionId, PropertyDefinitionInteger32, PropertyDefinitionObject, PropertyDefinitionString, PropertyDescription, PropertyDescriptionBinary, PropertyDescriptionBoolean, PropertyDescriptionDateTime, PropertyDescriptionFloat64, PropertyDescriptionId, PropertyDescriptionInteger32, PropertyDescriptionObject, PropertyDescriptionString, PropertyTemplate, PropertyTemplateBinary, PropertyTemplateBoolean, PropertyTemplateDateTime, PropertyTemplateFloat64, PropertyTemplateId, PropertyTemplateInteger32, PropertyTemplateObject, PropertyTemplateString, QueryEvent, QueueItem, Realm, ReferentialContainmentRelationship, Relationship, ReplicableClassDefinition, ReplicationConfiguration, ReplicationGroup, ReplicationJournalEntry, ReplicationParticipant, Repository, RetrievalEvent, SecurityPolicy, SecurityPrincipal, SecurityTemplate, ServerCacheConfiguration, ServerInstance, Site, SiteSettings, SnapLockFixedContentDevice, StorageArea, StoragePolicy, StoredSearch, SubscribableClassDefinition, SubscribedEvent, Subscription, SubsystemConfiguration, TableDefinition, TakeFederatedOwnershipEvent, TivoliFixedContentDevice, TraceLoggingConfiguration, UnfileEvent, UnlockEvent, UpdateEvent, UpdateSecurityEvent, UpgradeAddOn, User, VersionableClassDefinition, VersioningSecurityTemplate, VersionSeries, VirtualServer, WorkflowDefinition, WorkflowEventAction, XMLPropertyMappingScript
public interface EngineObject extends java.io.Serializable
Represents the top-level interface from which most of the other Content Engine API interfaces derive. AnEngineObject
is any object known to the Content Engine, including objects outside of repositories, such as a service or anObjectStore
object itself. Contrast this withRepositoryObject
, which represents any object residing within a Content Engine repository.You will not normally work directly with an
EngineObject
, but rather with an instance of one of its subclasses, which are further grouped into independent and dependent objects. AnIndependentObject
is anEngineObject
that has its own identity and always has anObjectReference
. ADependentObject
is anEngineObject
that can only exist within the scope of another object. An example of this dependency isContentElement
; content elements are scoped to a particularDocument
object and cannot exist independently.This interface provides some base functionality, such as retrieving the
Connection
object that is used for communication to the Content Engine server and retrieving an object's class information and properties.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ClassDescription
get_ClassDescription()
Returns theClassDescription
object that describes the immutable metadata of the class from which this object is instantiated.java.lang.String
getClassName()
Returns the identity of the metadata class from which this object is instantiated.Connection
getConnection()
Returns aConnection
object that represents a logical connection to the FileNet P8 domain.Properties
getProperties()
Returns a collection of property values for this object.java.lang.String[]
getSuperClasses()
Returns aString
array specifying the names of the superclasses of the class from which this object is instantiated.
-
-
-
Method Detail
-
get_ClassDescription
ClassDescription get_ClassDescription()
Returns theClassDescription
object that describes the immutable metadata of the class from which this object is instantiated.- Returns:
- A
ClassDescription
object.
-
getConnection
Connection getConnection()
Returns aConnection
object that represents a logical connection to the FileNet P8 domain. The returnedConnection
object is used as input to methods such as factory instantiation methods andUserContext.createSubject
.- Returns:
- A
Connection
object.
-
getProperties
Properties getProperties()
Returns a collection of property values for this object. Note that an object reference will not have values in its property collection; therefore, if the properties of an object reference are required, you should refresh the object before calling this method.- Returns:
- A
Properties
collection representing the cached properties of this object.
-
getClassName
java.lang.String getClassName()
Returns the identity of the metadata class from which this object is instantiated. If the object is newly created and a non-null value was provided for theclassId
parameter of theFactory createInstance
method by which the object was created, this method returns that non-null value. In all other circumstances the symbolic name of the metadata class is returned.- Returns:
- A
String
specifying the name of the class.
-
getSuperClasses
java.lang.String[] getSuperClasses()
Returns aString
array specifying the names of the superclasses of the class from which this object is instantiated.- Returns:
- A
String
array specifying the list of superclass names.
-
-