Refreshes this object and retrieves from the server the object referenced by the object-valued property specified by the
parameter and populates its properties according to the
.
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, _ ByVal pageSize As Nullable(Of Integer) _ ) As IProperty |
C# |
---|
public abstract IProperty FetchProperty( string propertyName, PropertyFilter filter, Nullable<int> pageSize ) |
C++ |
---|
public: IProperty FetchProperty( String propertyName, PropertyFilter filter, Nullable<int> pageSize ) abstract |
J# |
---|
public abstract IProperty FetchProperty( string propertyName, PropertyFilter filter, Nullable<int> pageSize ) |
JScript |
---|
public abstract
function FetchProperty( propertyName : String, filter : PropertyFilter, pageSize : Nullable<int> ) : IProperty |
Parameters
- propertyName
- A
specifying the name of the object-valued property.String
- filter
- A
object that represents information for controlling which property values (and with what level of detail and recursion) to return. IfPropertyFilter
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (null
properties with a state ofPropertyEngineObject
orPropertyState.UNEVALUATED
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.PropertyState.REFERENCE
- pageSize
- An
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 theInteger
, this method will need to be called multiple times to retrieve all of the properties. If this parameter isfilter
, all of the properties that are specified by theNull
will be retrieved in a single fetch. Iffilter
, this method returns only non-object property values for this object.Null
Return Value
A
object.
Exceptions
Exception Type | Condition |
---|---|
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 parameter does not return an object. |