com.filenet.api.property

Interface PropertyEngineObject

All Superinterfaces:

Property, java.io.Serializable

public interface PropertyEngineObject
extends Property

Represents a Content Engine property that holds an EngineObject object.

See Also:

EngineObject, ObjectReference

Method Summary

Modifier and Type	Method and Description
IndependentObject	fetchIndependentObject(PropertyFilter filter) Retrieves the value of a PropertyEngineObject property that holds an IndependentObject object by making a roundtrip to the server using an optional property filter.
ObjectReference	getObjectReference() Returns an object reference to the EngineObject value held by this PropertyEngineObject 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 - An EngineObject that specifies the new property value.

Throws:

E_READ_ONLY - if an attempt is made to update a property that is not settable (its Property.isSettable method returns false).

fetchIndependentObject

IndependentObject fetchIndependentObject(PropertyFilter filter)

Retrieves the value of a PropertyEngineObject property that holds an IndependentObject object by making a roundtrip to the server using an optional property filter. If this method is called by a property that holds a DependentObject, an error will be thrown.

Parameters:

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.

Returns:

An IndependentObject object.

Throws:

API_METHOD_NO_DEPENDENT_SUPPORT - if an attempt is made to retrieve a DependentObject object.

getObjectReference

ObjectReference getObjectReference()

Returns an object reference to the EngineObject value held by this PropertyEngineObject property.

Returns:

An ObjectReference object.