org.osid.bidding

Interface BidSearchSession

All Superinterfaces:

java.lang.AutoCloseable, BidQuerySession, java.io.Closeable, OsidSession

public interface BidSearchSession
extends BidQuerySession

This session provides methods for searching among Bid objects. The search query is constructed using the BidQuery.

getBidsByQuery() is the basic search method and returns a list of Bids. A more advanced search may be performed with getBidsBySearch(). It accepts a BidSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBidsBySearch() returns a BidSearchResults that can be used to access the resulting BidList or be used to perform a search within the result set through BidSearch.

This session defines views that offer differing behaviors for searching.

• federated auction house view: searches include bids in auction houses of which this auction house is an ancestor in the auction house hierarchy
• isolated auction house view: searches are restricted to bids in this auction house

Bids may have a query record indicated by their respective record types. The query record is accessed via the BidQuery.

Method Summary

Methods

Modifier and Type	Method and Description
BidQuery	getBidQueryFromInspector(BidQueryInspector bidQueryInspector) Gets a bid query from an inspector.
BidSearchResults	getBidsBySearch(BidQuery bidQuery, BidSearch bidSearch) Gets the search results matching the given search query using the given search.
BidSearch	getBidSearch() Gets a bid search.
BidSearchOrder	getBidSearchOrder() Gets a bid search order.

Methods inherited from interface org.osid.bidding.BidQuerySession

canSearchBids, getAuctionHouse, getAuctionHouseId, getBidQuery, getBidsByQuery, useFederatedAuctionHouseView, useIsolatedAuctionHouseView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBidSearch

BidSearch getBidSearch()

Gets a bid search.

Returns:

the bid search

Compliance:

mandatory - This method must be implemented.

getBidSearchOrder

BidSearchOrder getBidSearchOrder()

Gets a bid search order. The BidSearchOrder is supplied to a BidSearch to specify the ordering of results.

Returns:

the bid search order

Compliance:

mandatory - This method must be implemented.

getBidsBySearch

BidSearchResults getBidsBySearch(BidQuery bidQuery,
                               BidSearch bidSearch)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

bidQuery - the bid query

bidSearch - the bid search

Returns:

the returned search results

Throws:

NullArgumentException - bidQuery or bidSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - bidQuery or bidSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBidQueryFromInspector

BidQuery getBidQueryFromInspector(BidQueryInspector bidQueryInspector)

Gets a bid query from an inspector. The inspector is available from a BidSearchResults.

Parameters:

bidQueryInspector - a bid query inspector

Returns:

the bid query

Throws:

NullArgumentException - bidQueryInspector is null

UnsupportedException - bidQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.