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)
Visual Basic (Declaration) |
---|
Function FetchProperty ( _
propertyName As String, _
filter As PropertyFilter, _
pageSize As Nullable(Of Integer) _
) As IProperty |
JavaScript |
---|
function fetchProperty(propertyName, filter, pageSize); |
Parameters
- propertyName
- Type: System..::.String
A String specifying the name of the object-valued property.
- filter
- Type: FileNet.Api.Property..::.PropertyFilter
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
- Type: System..::.Nullable<(Of <(Int32>)>)
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. If Null,
this method returns only non-object property values for this object.
Return Value
A
Property object.