Interface IndependentObject
-
- All Superinterfaces:
- EngineObject, java.io.Serializable
- All Known Subinterfaces:
- Action, ActionConsumer, AddOn, Annotation, AsyncUpgradeQueueItem, AuditConfigurationEvent, CancelCheckoutEvent, CenteraFixedContentDevice, ChangeClassEvent, ChangeStateEvent, CheckinEvent, CheckoutEvent, ChoiceList, ClassDefinition, ClassDescription, ClassifyCompleteEvent, ClassSubscription, ClassWorkflowSubscription, CmAbstractPersistable, CmAbstractQueueEntry, CmAbstractSequential, CmAtmosFixedContentDevice, CmAuditDispositionPolicy, CmAuditProcessingBookmark, CmBulkMoveContentJob, CmChangePreprocessorAction, CmContentMigrationPolicy, CmCustomQueueSweep, CmCustomSweepJob, CmCustomSweepPolicy, CmDatabaseConnection, CmDisposalPolicy, CmEventExportStore, CmHitachiFixedContentDevice, CmHold, CmHoldRelationship, CmIndexRequest, CmJobSweepResult, CmMarkForDeletionEvent, CmMoveContentEvent, CMODApplicationGroup, CMODFixedContentDevice, CMODRepository, CmPolicyControlledSweep, CmPolicySweepResult, CmQueueEntryClassDefinition, CmQueueSweep, CmRecoverEvent, CmRecoveryBin, CmRecoveryItem, CmRetentionUpdateJob, CmRetentionUpdatePolicy, CmSweep, CmSweepAction, CmSweepJob, CmSweepPolicy, CmSweepPolicyRelationship, CmSweepRelationship, CmSweepResult, CmTask, CmTaskRelationship, CmTextSearchAffinityGroup, CmTextSearchIndexArea, CmTextSearchIndexRequest, CmTextSearchServer, CmThumbnail, CmThumbnailGenerationJob, CmThumbnailGenerationSubscription, CmThumbnailRequest, CmThumbnailRequestSweep, CmTivoliManagementClass, CmVerityIndexRequest, CodeModule, ComponentRelationship, ContainmentRelationship, ContentCacheArea, ContentFederatingRepository, CreationEvent, CustomEvent, CustomObject, DatabaseStorageArea, DeletionEvent, DemoteVersionEvent, DITARenditionEngineConnection, Document, DocumentClassDefinition, DocumentClassificationAction, DocumentClassificationQueueItem, DocumentLifecycleAction, DocumentLifecyclePolicy, Domain, DynamicReferentialContainmentRelationship, EntireNetwork, Event, EventAction, EventClassDefinition, EventQueueItem, ExternalClassDescription, ExternalRepository, FileEvent, FileStorageArea, FixedContentDevice, FixedStorageArea, Folder, FreezeEvent, GenericFixedContentDevice, GetContentEvent, GetObjectEvent, Group, IICEFixedContentDevice, ImageServicesRepository, IMFixedContentDevice, IndependentlyPersistableObject, IndexArea, IndexJob, InstanceSubscription, InstanceWorkflowSubscription, IsolatedRegion, Link, LockEvent, MarkingSet, ObjectChangeEvent, ObjectStore, PEConnectionPoint, PromoteVersionEvent, PropertyTemplate, PropertyTemplateBinary, PropertyTemplateBoolean, PropertyTemplateDateTime, PropertyTemplateFloat64, PropertyTemplateId, PropertyTemplateInteger32, PropertyTemplateObject, PropertyTemplateString, PublishCompleteEvent, PublishRequest, PublishRequestEvent, PublishStyleTemplate, PublishTemplate, QueryEvent, QueueItem, Realm, ReferentialContainmentRelationship, Relationship, RenditionEngineConnection, ReplicableClassDefinition, ReplicationGroup, ReplicationJournalEntry, Repository, RetrievalEvent, SecurityPolicy, SecurityPrincipal, SecurityPropagationQueueItem, ServerInstance, Site, SnapLockFixedContentDevice, StorageArea, StoragePolicy, StoredSearch, SubscribableClassDefinition, Subscription, TableDefinition, TakeFederatedOwnershipEvent, TivoliFixedContentDevice, UnfileEvent, UnlockEvent, UpdateEvent, UpdateSecurityEvent, UpgradeAddOn, User, VerityDomainConfiguration, VerityIndexArea, VersionableClassDefinition, VersionSeries, VirtualServer, WorkflowDefinition, WorkflowEventAction, XMLPropertyMappingScript
public interface IndependentObject extends EngineObject
Indicates objects that are independent.An
IndependentObject
represents anEngineObject
that has its own independent identity. Contrast this with aDependentObject
, which 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.) AnIndependentObject
can be retrieved from the server with a call toInstantiatingScope.fetchObject
orFactory.<classname>.fetchInstance
, whereas aDependentObject
can only be fetched as a property of anIndependentObject
.An
IndependentObject
always has anObjectReference
, which can be obtained by callinggetObjectReference
. AnObjectReference
provides identity information for the object.IndependentObject.equals
(which overridesjava.lang.Object.equals
) delegates toObjectReference.equals
for object comparisons. For information aboutequals
implementation, see theObjectReference
interface description.When calling the
refresh
methods, note that the behavior differs from that of fetch-related methods (fetchProperty
andfetchProperties
). The fetch-related methods retrieve the object and merge retrieved property information into the current contents of the property cache. Therefresh
methods retrieve the object and replace the current contents of the property cache with the retrieved property information.
-
-
Method Summary
Methods Modifier and Type Method and Description void
fetchProperties(PropertyFilter filter)
Retrieves this object from the server and merges existing information in the property cache with the retrieved information for the properties specified by the filter.void
fetchProperties(java.lang.String[] propertyNames)
Retrieves this object from the server and merges existing information in the property cache with the retrieved information for the specified properties.Property
fetchProperty(java.lang.String propertyName, PropertyFilter filter)
Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by thepropertyName
parameter and populates its properties according to the filter.Property
fetchProperty(java.lang.String propertyName, PropertyFilter filter, java.lang.Integer pageSize)
Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by thepropertyName
parameter and populates its properties according to the filter.ObjectReference
getObjectReference()
Returns an object reference that represents the object's identity.void
refresh()
Retrieves this object from the server and replaces existing information in the property cache with the retrieved property information.void
refresh(PropertyFilter filter)
Retrieves this object from the server and replaces existing information in the property cache with the retrieved information for the properties specified by the filter.void
refresh(java.lang.String[] propertyNames)
Retrieves this object from the server and replaces existing information in the property cache with the retrieved information for the specified properties.-
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
-
-
-
-
Method Detail
-
refresh
void refresh()
Retrieves this object from the server and replaces existing information in the property cache with the retrieved property information.
-
refresh
void refresh(java.lang.String[] propertyNames)
Retrieves this object from the server and replaces existing information in the property cache with the retrieved information for the specified properties.- Parameters:
propertyNames
- AString
array of property names identifying the properties to return with the retrieved object.- Throws:
E_INVALID_ARGUMENT
- if thepropertyNames
parameter isnull
or is an empty array.
-
refresh
void refresh(PropertyFilter filter)
Retrieves this object from the server and replaces existing information in the property cache with the retrieved information for the properties specified by the filter.- Parameters:
filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.REFERENCE
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.
-
fetchProperties
void fetchProperties(java.lang.String[] propertyNames)
Retrieves this object from the server and merges existing information in the property cache with the retrieved information for the specified properties. If this object has changed on the server since it was last retrieved, you should call arefresh
method first; otherwise, an error will be thrown.- Parameters:
propertyNames
- AString
array of property names identifying the properties to return with the retrieved object.- Throws:
E_INVALID_ARGUMENT
- if thepropertyNames
parameter isnull
or is an empty array.API_FETCH_MERGE_PROPERTY_ERROR
- if the object has been changed on the server since it was last retrieved.
-
fetchProperties
void fetchProperties(PropertyFilter filter)
Retrieves this object from the server and merges existing information in the property cache with the retrieved information for the properties specified by the filter. If this object has changed on the server since it was last retrieved, you should call arefresh
method first; otherwise, an error will be thrown.- Parameters:
filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. This parameter cannot benull
.- Throws:
E_INVALID_ARGUMENT
- if thefilter
parameter isnull
.API_FETCH_MERGE_PROPERTY_ERROR
- if the object has been changed on the server since it was last retrieved.
-
fetchProperty
Property fetchProperty(java.lang.String propertyName, PropertyFilter filter)
Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by thepropertyName
parameter and populates its properties according to the filter.- Parameters:
propertyName
- AString
specifying the name of the object-valued property.filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.REFERENCE
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.- Returns:
- A
Property
object. - Throws:
API_SAVE_BEFORE_REFRESH
- if you attempt to retrieve properties for a new object that has not yet been saved.TRANSPORT_EXPECTED_ENGINEOBJECT_RESPONSE
- if the property specified by thepropertyName
parameter does not return an object.
-
fetchProperty
Property fetchProperty(java.lang.String propertyName, PropertyFilter filter, java.lang.Integer pageSize)
Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by thepropertyName
parameter and populates its properties according to the filter.- Parameters:
propertyName
- AString
specifying the name of the object-valued property.filter
- APropertyFilter
object that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject
properties with a state ofPropertyState.UNEVALUATED
orPropertyState.REFERENCE
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.pageSize
- AnInteger
that specifies the maximum number of properties that will be retrieved at a time from the server. If this number is smaller than the number of properties that are specified by the filter, this method will need to be called multiple times to retrieve all of the properties. If this parameter isnull
, all of the properties that are specified by the filter will be retrieved in a single fetch.- Returns:
- A
Property
object. - Throws:
API_SAVE_BEFORE_REFRESH
- if you attempt to retrieve properties for a new object that has not yet been saved.TRANSPORT_EXPECTED_ENGINEOBJECT_RESPONSE
- if the property specified by thepropertyName
parameter does not return an object.
-
getObjectReference
ObjectReference getObjectReference()
Returns an object reference that represents the object's identity. The ID of an independent object is the class name and ID of the object. The ID can be a path, GUID, or name of the object.- Returns:
- An
ObjectReference
object.
-
-