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, CmDirectoryConfigurationOID, CMODApplicationGroup, CMODFixedContentDevice, CMODRepository, 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, DITARenditionEngineConnection, 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, PublishCompleteEvent, PublishingConfiguration, PublishRequest, PublishRequestEvent, PublishStyleTemplate, PublishTemplate, QueryEvent, QueueItem, Realm, ReferentialContainmentRelationship, Relationship, RenditionEngineConnection, ReplicableClassDefinition, ReplicationConfiguration, ReplicationGroup, ReplicationJournalEntry, ReplicationParticipant, Repository, RetrievalEvent, SecurityPolicy, SecurityPrincipal, SecurityPropagationQueueItem, SecurityTemplate, ServerCacheConfiguration, ServerInstance, Site, SiteSettings, SnapLockFixedContentDevice, StorageArea, StoragePolicy, SubscribableClassDefinition, SubscribedEvent, Subscription, SubsystemConfiguration, TableDefinition, TakeFederatedOwnershipEvent, TivoliFixedContentDevice, TraceLoggingConfiguration, UnfileEvent, UnlockEvent, UpdateEvent, UpdateSecurityEvent, UpgradeAddOn, User, VerityCollection, VerityDomainConfiguration, VerityIndexArea, VerityServerConfiguration, 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. An EngineObject
is any object known to the Content Engine, including
objects outside of repositories, such as a service or an ObjectStore
object
itself. Contrast this with RepositoryObject
, 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. An IndependentObject
is an EngineObject
that has
its own identity and always has an ObjectReference
.
A DependentObject
is an EngineObject
that can only exist
within the scope of another object. An example of this dependency is ContentElement
;
content elements are scoped to a particular Document
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 |
ClassDescription |
get_ClassDescription()
Returns the ClassDescription object that describes the immutable metadata
of the class from which this object is instantiated. |
java.lang.String |
getClassName()
Returns the name of the class from which this object is instantiated. |
Connection |
getConnection()
Returns a Connection 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 a String array specifying the names of the superclasses of the
class from which this object is instantiated. |
get_ClassDescription
ClassDescription get_ClassDescription()
- Returns the
ClassDescription
object that describes the immutable metadata
of the class from which this object is instantiated.
- Returns:
- A
ClassDescription
object.
getConnection
Connection getConnection()
- Returns a
Connection
object that represents a logical connection to the
FileNet P8 domain. The returned Connection
object is used as input to methods
such as factory instantiation methods and
UserContext.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 name of the class from which this object is instantiated.
- Returns:
- A
String
specifying the name of the class.
getSuperClasses
java.lang.String[] getSuperClasses()
- Returns a
String
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.
© Copyright IBM Corporation 2006, 2009. All rights reserved.