EngineObject
objects from the repository or repositories specified for the SearchScope
instance. The following property settings can affect this method:
ObjectStore.DefaultQueryTimeLimit ObjectStore.MaxQueryTimeLimit IServerCacheConfiguration.QueryPageMaxSize IServerCacheConfiguration.QueryPageDefaultSize IServerCacheConfiguration.NonPagedQueryMaxSize
Namespace: FileNet.Api.Query
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function FetchObjects( _ ByVal searchSQL As SearchSQL, _ ByVal pageSize As Nullable(Of Integer), _ ByVal filter As PropertyFilter, _ ByVal continuable As Nullable(Of Boolean) _ ) As IIndependentObjectSet |
C# |
---|
public IIndependentObjectSet FetchObjects( SearchSQL searchSQL, Nullable<int> pageSize, PropertyFilter filter, Nullable<bool> continuable ) |
C++ |
---|
public: IIndependentObjectSet FetchObjects( SearchSQL searchSQL, Nullable<int> pageSize, PropertyFilter filter, Nullable<bool> continuable ) sealed |
J# |
---|
public IIndependentObjectSet FetchObjects( SearchSQL searchSQL, Nullable<int> pageSize, PropertyFilter filter, Nullable<bool> continuable ) |
JScript |
---|
public
function FetchObjects( searchSQL : SearchSQL, pageSize : Nullable<int>, filter : PropertyFilter, continuable : Nullable<bool> ) : IIndependentObjectSet |
Parameters
- searchSQL
- A
instance containing the SQL statement to use for the search.SearchSQL
- pageSize
- An
indicating the maximum number of objects per page to retrieve. This can beInteger
. When unspecified, the default page size (Null
)is used.ServerCacheCofiguration.QueryPageDefaultSize Note: If the
parameter is false orcontinuable
, thisNull
value is ignored.pageSize The number you specify here determines what constitutes a page of query result data. This value, in conjunction with the (
) value you specify for theBoolean
parameter, can impact retrieval performance.continuable
- 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
- continuable
- A
value. If false orBoolean
, the query is not paged, theNull
parameter and the default page size inpageSize
are ignored, and the query will return a number of objects limited by the following values:ServerCacheCofiguration.QueryPageDefaultSize - The "TOP" value (if specified) in the selection list.
- The value of
.ServerCacheCofiguration.NonPagedQueryMaxSize
If this
value is true, the query can be continued. In this case, when the end of the first page is reached, a request for the next page ofcontinuable
objects is issued. Page requests iterate until all of theEngineObject
objects satisfying the query are retrieved.EngineObject Queries using continuation use
in their implementation. If anORDER BY
clause is not specified in the SQL statement (theORDER BY
parameter), ansearchSQL
clause is used. If anORDER BY Id
is specified in the SQL statement, but does not contain theORDER BY clause
property, theId
property (having a unique value) is appended to the end of theId
clause. You should consider whether the overhead of adding theORDER BY
property to theId
clause is significant for your application. Do not use a continuable query if it would cause a severe performance reduction.ORDER BY
Return Value
An
collection object containing the
objects retrieved.