SearchBaskets Method (SearchClause, SearchOptions, Int32)

Article
11/12/2009

Returns a DataSet containing baskets that match a supplied search criteria along. The total number of returned records are available.

Namespace: Microsoft.CommerceServer.Orders
Assembly: Microsoft.CommerceServer.Orders.CrossTierTypes (in Microsoft.CommerceServer.Orders.CrossTierTypes.dll)

Syntax

'Declaration
Public Function SearchBaskets ( _
    searchClause As SearchClause, _
    searchOptions As SearchOptions, _
    <OutAttribute> ByRef recordsMatched As Integer _
) As DataSet

'Usage
Dim instance As BasketManager
Dim searchClause As SearchClause
Dim searchOptions As SearchOptions
Dim recordsMatched As Integer
Dim returnValue As DataSet

returnValue = instance.SearchBaskets(searchClause, _
    searchOptions, recordsMatched)

public DataSet SearchBaskets(
    SearchClause searchClause,
    SearchOptions searchOptions,
    out int recordsMatched
)

public:
DataSet^ SearchBaskets(
    SearchClause^ searchClause, 
    SearchOptions^ searchOptions, 
    [OutAttribute] int% recordsMatched
)

public function SearchBaskets(
    searchClause : SearchClause, 
    searchOptions : SearchOptions, 
    recordsMatched : int
) : DataSet

Parameters

searchClause
Type: Microsoft.CommerceServer..::.SearchClause
XML blob representing the search criteria.

searchOptions
Type: Microsoft.CommerceServer..::.SearchOptions
The SearchOptions containing the search options. Passing nullNothingnullptra null reference (Nothing in Visual Basic) means to use default search options.

recordsMatched
Type: System..::.Int32%
Returns the total number of records that matched the given query.

Return Value

Type: System.Data..::.DataSet
The DataSet containing the baskets that match the search clause.

Exceptions

Exception	Condition
ArgumentNullException	The searchClause is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The specified search clause is not a well formed search clause.
NotAuthorizedException	The user does not have permission to perform this operation.
TimeoutException	Thrown if an SQL command timeout occurs.

Remarks

The DataSet contains just the top level properties from Basket class. It contains a DataTable named Basket with columns named as properties to return. The DataSet does not contain all the records that match the criteria. It is populated with the pages the user asks for using the search options.

In order to perform a SearchBaskets, the user must have the OrdersViewer permissions. See Orders System Roles [CS06] for more information about the specific roles in the Order System.

Some order system APIs support distributed transactions. If a cookie with a valid transaction is found the order system enlists as part of that transaction. If a valid transaction is not found the order system initiates a new transaction.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via