Interface BidSearchSession

All Superinterfaces:

AutoCloseable, BidQuerySession, Closeable, OsidSession, OsidSession

public interface BidSearchSession
extends BidQuerySession

This session provides methods for searching among Bids . 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

Modifier and Type	Method	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 BidQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchBids()	Tests if this user can perform Bid lookups.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
BidQuery	getBidQuery()	Gets a bid query.
BidList	getBidsByQuery(BidQuery bidQuery)	Gets a list of Bids matching the given search.
void	useFederatedAuctionHouseView()	Federates the view for methods in this session.
void	useIsolatedAuctionHouseView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.