com.filenet.api.property
Interface PropertyEngineObject
-
- All Superinterfaces:
- Property, java.io.Serializable
public interface PropertyEngineObject extends Property
Represents a Content Engine property that holds anEngineObject
object.- See Also:
EngineObject
,ObjectReference
-
-
Method Summary
Methods Modifier and Type Method and Description IndependentObject
fetchIndependentObject(PropertyFilter filter)
Retrieves the value of aPropertyEngineObject
property that holds anIndependentObject
object by making a roundtrip to the server using an optional property filter.ObjectReference
getObjectReference()
Returns an object reference to theEngineObject
value held by thisPropertyEngineObject
property.void
setValue(EngineObject val)
Sets the value of this Content Engine property.-
Methods inherited from interface com.filenet.api.property.Property
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getDependentObjectListValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getIndependentObjectSetValue, getInputStreamValue, getInteger32ListValue, getInteger32Value, getObjectValue, getPropertyName, getRetrievalErrorValue, getState, getStringListValue, getStringValue, isDirty, isSettable, setObjectValue
-
-
-
-
Method Detail
-
setValue
void setValue(EngineObject val)
Sets the value of this Content Engine property.- Parameters:
val
- AnEngineObject
that specifies the new property value.- Throws:
E_READ_ONLY
- if an attempt is made to update a property that is not settable (itsProperty.isSettable
method returnsfalse
).
-
fetchIndependentObject
IndependentObject fetchIndependentObject(PropertyFilter filter)
Retrieves the value of aPropertyEngineObject
property that holds anIndependentObject
object by making a roundtrip to the server using an optional property filter. If this method is called by a property that holds aDependentObject
, 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. 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:
- An
IndependentObject
object. - Throws:
API_METHOD_NO_DEPENDENT_SUPPORT
- if an attempt is made to retrieve aDependentObject
object.
-
getObjectReference
ObjectReference getObjectReference()
Returns an object reference to theEngineObject
value held by thisPropertyEngineObject
property.- Returns:
- An
ObjectReference
object.
-
-