Interface BidEnablerSearchSession

All Superinterfaces:

AutoCloseable, BidEnablerQuerySession, Closeable, OsidSession, OsidSession

public interface BidEnablerSearchSession
extends BidEnablerQuerySession

This session provides methods for searching among BidEnablers . The search query is constructed using the BidEnablerQuery .

getBidEnablersByQuery() is the basic search method and returns a list of BidEnablers . A more advanced search may be performed with getBidEnablersBySearch() .It accepts a BidEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBidEnablersBySearch() returns a BidEnablerSearchResults that can be used to access the resulting BidEnablerList or be used to perform a search within the result set through Bid EnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Bid enablers may have a query record indicated by their respective record types. The query record is accessed via the BidEnablerQuery .

Method Summary

Modifier and Type	Method	Description
BidEnablerQuery	getBidEnablerQueryFromInspector(BidEnablerQueryInspector bidEnablerQueryInspector)	Gets a bid enabler query from an inspector.
BidEnablerSearchResults	getBidEnablersBySearch(BidEnablerQuery bidEnablerQuery, BidEnablerSearch bidEnablerSearch)	Gets the search results matching the given search query using the given search.
BidEnablerSearch	getBidEnablerSearch()	Gets a bid enabler search.
BidEnablerSearchOrder	getBidEnablerSearchOrder()	Gets a bid enabler search order.

Methods inherited from interface BidEnablerQuerySession

canSearchBidEnablers, getAuctionHouse, getAuctionHouseId, getBidEnablerQuery, getBidEnablersByQuery, useFederatedAuctionHouseView, useIsolatedAuctionHouseView

Modifier and Type	Method	Description
boolean	canSearchBidEnablers()	Tests if this user can perform BidEnabler searches.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
BidEnablerQuery	getBidEnablerQuery()	Gets a bid enabler query.
BidEnablerList	getBidEnablersByQuery(BidEnablerQuery bidEnablerQuery)	Gets a list of BidEnablers 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

getBidEnablerSearch

BidEnablerSearch getBidEnablerSearch()

Gets a bid enabler search.

Returns:

the bid enabler search

Compliance:

mandatory - This method must be implemented.

getBidEnablerSearchOrder

BidEnablerSearchOrder getBidEnablerSearchOrder()

Gets a bid enabler search order. The BidEnablerSearchOrder is supplied to a BidEnablerSearch to specify the ordering of results.

Returns:

the bid enabler search order

Compliance:

mandatory - This method must be implemented.

getBidEnablersBySearch

BidEnablerSearchResults getBidEnablersBySearch(BidEnablerQuery bidEnablerQuery,
 BidEnablerSearch bidEnablerSearch)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

bidEnablerQuery - the bid enabler query

bidEnablerSearch - the bid enabler search

Returns:

the returned search results

Throws:

NullArgumentException - bidEnablerQuery or bidEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - bidEnablerQuery or bidEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBidEnablerQueryFromInspector

BidEnablerQuery getBidEnablerQueryFromInspector(BidEnablerQueryInspector bidEnablerQueryInspector)

Gets a bid enabler query from an inspector. The inspector is available from a BidEnablerSearchResults .

Parameters:

bidEnablerQueryInspector - a bid enabler query inspector

Returns:

the bid enabler query

Throws:

NullArgumentException - bidEnablerQueryInspector is null

UnsupportedException - bidEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.