PrepareInstancePageQueryCommand Method (StorageDbDataAccessAgent)

Initializes a System.Data.IDbCommand object to query for Composite Instance information using matching parameters for pagination.

Syntax

Visual Basic
C#
Objective-C
Java
C++

protected abstract void PrepareInstancePageQueryCommand( 
   IDbCommand command,
   Collection<CatalogElement[]> matchingParamsCollection,
   QueryPageInfo queryPageInfo
)

'Declaration
 
Protected MustOverride Sub PrepareInstancePageQueryCommand( _
   ByVal command As IDbCommand, _
   ByVal matchingParamsCollection As Collection(Of CatalogElement()), _
   ByVal queryPageInfo As QueryPageInfo _
)

'Usage
 
Dim instance As StorageDbDataAccessAgent
Dim command As IDbCommand
Dim matchingParamsCollection As Collection(Of CatalogElement())
Dim queryPageInfo As QueryPageInfo
 
instance.PrepareInstancePageQueryCommand(command, matchingParamsCollection, queryPageInfo)

protected:
abstract void PrepareInstancePageQueryCommand( 
   IDbCommand^ command,
   Collection<array<CatalogElement^>>^ matchingParamsCollection,
   QueryPageInfo^ queryPageInfo
)

Parameters

command: Type: System.Data.IDbCommand The database command that will be initialized to execute the query.
matchingParamsCollection: Type: Collection of Leadtools.Medical.DataAccessLayer.Catalog.CatalogElement Array The matching parameters for the query.
queryPageInfo: Type: Leadtools.Medical.DataAccessLayer.QueryPageInfo Specifies the page number and page size that will result from the executing the query.

Remarks

This is similar to the PrepareInstancePageQueryCommand method, except that the query will generate paginated results. The queryPageInfo is used to specify a page number and page size for the results. For example, suppose that the executing the query returns 100 rows. If queryPageInfo specifies a page size of 10, and a page number of 3. Executing the query will then return 10 total rows (the page size) starting with row 30 (PageNumber * PageSize). Therefore, the result would be rows 30 through 40.

Note to inheritors:

The patient, studies and series information should be included with the composite instances information.

Each Leadtools.Medical.DataAccessLayer.Catalog.CatalogElement is a matching parameter value.

All Leadtools.Medical.DataAccessLayer.Catalog.CatalogElement in an array will be combined with AND operation in the condition statement.

Each array in the collection will be combined with OR operation in the condition statement.

Requirements

Target Platforms

Reference

StorageDbDataAccessAgent Class
StorageDbDataAccessAgent Members