|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndependentObject
Indicates objects that are independent.
An IndependentObject
represents
an EngineObject
that has its own independent identity. Contrast
this with a DependentObject
, which 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.) An IndependentObject
can be retrieved from the server with a call
to InstantiatingScope.fetchObject
or Factory.<classname>.fetchInstance
, whereas a
DependentObject
can only be fetched as a property of an IndependentObject
.
An IndependentObject
always has an ObjectReference
,
which can be obtained by calling getObjectReference
. An ObjectReference
provides identity information for the object.
IndependentObject.equals
(which overrides java.lang.Object.equals
)
delegates to ObjectReference.equals
for object comparisons. For information about equals
implementation, see the
ObjectReference
interface description.
When calling the refresh
methods, note that the behavior differs from that of
fetch-related methods (fetchProperty
and fetchProperties
). The fetch-related
methods retrieve the object and merge retrieved property information into the current contents
of the property cache. The refresh
methods retrieve the object and replace
the current contents of the property cache with the retrieved property information.
Method Summary | |
---|---|
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 the propertyName 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 the propertyName 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 |
---|
void refresh()
void refresh(java.lang.String[] propertyNames)
propertyNames
- A String
array of property names identifying the
properties to return with the retrieved object.
E_INVALID_ARGUMENT
- if the propertyNames
parameter is null
or is
an empty array.void refresh(PropertyFilter filter)
filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.void fetchProperties(java.lang.String[] propertyNames)
refresh
method first;
otherwise, an error will be thrown.
propertyNames
- A String
array of property names identifying the
properties to return with the retrieved object.
E_INVALID_ARGUMENT
- if the propertyNames
parameter is null
or is
an empty array.
API_FETCH_MERGE_PROPERTY_ERROR
- if the object has been changed on the server since it was
last retrieved.void fetchProperties(PropertyFilter filter)
refresh
method first; otherwise, an error will be thrown.
filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
This parameter cannot be null
.
E_INVALID_ARGUMENT
- if the filter
parameter is null
.
API_FETCH_MERGE_PROPERTY_ERROR
- if the object has been changed on the server since it was
last retrieved.Property fetchProperty(java.lang.String propertyName, PropertyFilter filter)
propertyName
parameter and populates its properties
according to the filter.
propertyName
- A String
specifying the name of the object-valued property.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
Property
object.
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 the propertyName
parameter does not return an object.Property fetchProperty(java.lang.String propertyName, PropertyFilter filter, java.lang.Integer pageSize)
propertyName
parameter and populates its properties
according to the filter.
propertyName
- A String
specifying the name of the object-valued property.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.pageSize
- An Integer
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 is null
, all of the properties that are specified by
the filter will be retrieved in a single fetch.
Property
object.
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 the propertyName
parameter does not return an object.ObjectReference getObjectReference()
ObjectReference
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |