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.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public MustOverride Function FetchProperty( _ 
   ByVal propertyName As String,  _ 
   ByVal filter As PropertyFilter _ 
) As IProperty
C#
public abstract IProperty FetchProperty(
   string propertyName,
   PropertyFilter filter
)
C++
public:
 IProperty FetchProperty(
   String propertyName,
   PropertyFilter filter
) abstract 
J#
public abstract IProperty FetchProperty(
   string propertyName,
   PropertyFilter filter
)
JScript
public abstract  function FetchProperty(
   propertyName : String,
   filter : PropertyFilter
) : IProperty

Parameters

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.

Return Value

A Property object.

Exceptions

Exception TypeCondition
API_SAVE_BEFORE_REFRESH Thrown if you attempt to retrieve properties for a new object that has not yet been saved.
TRANSPORT_EXPECTED_ENGINEOBJECT_RESPONSE Thrown if the property specified by the propertyName parameter does not return an object.

See Also