Interface AuctionSearchSession

All Superinterfaces:

AuctionQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionSearchSession
extends AuctionQuerySession

This session provides methods for searching among Auctions . The search query is constructed using the AuctionQuery .

getAuctionsByQuery() is the basic search method and returns a list of Auctions . A more advanced search may be performed with getAuctionsBySearch() .It accepts an AuctionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuctionsBySearch() returns an AuctionSearchResults that can be used to access the resulting AuctionList or be used to perform a search within the result set through AuctionSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
AuctionQuery	getAuctionQueryFromInspector(AuctionQueryInspector auctionQueryInspector)	Gets an auction query from an inspector.
AuctionSearchResults	getAuctionsBySearch(AuctionQuery auctionQuery, AuctionSearch auctionSearch)	Gets the search results matching the given search query using the given search.
AuctionSearch	getAuctionSearch()	Gets an auction search.
AuctionSearchOrder	getAuctionSearchOrder()	Gets an auction search order.

Methods inherited from interface AuctionQuerySession

canSearchAuctions, getAuctionHouse, getAuctionHouseId, getAuctionQuery, getAuctionsByQuery, useFederatedAuctionHouseView, useIsolatedAuctionHouseView

Modifier and Type	Method	Description
boolean	canSearchAuctions()	Tests if this user can perform Auction lookups.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
AuctionQuery	getAuctionQuery()	Gets an auction query.
AuctionList	getAuctionsByQuery(AuctionQuery auctionQuery)	Gets a list of Auctions 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

getAuctionSearch

AuctionSearch getAuctionSearch()

Gets an auction search.

Returns:

the auction search

Compliance:

mandatory - This method must be implemented.

getAuctionSearchOrder

AuctionSearchOrder getAuctionSearchOrder()

Gets an auction search order. The AuctionSearchOrder is supplied to an AuctionSearch to specify the ordering of results.

Returns:

the auction search order

Compliance:

mandatory - This method must be implemented.

getAuctionsBySearch

AuctionSearchResults getAuctionsBySearch(AuctionQuery auctionQuery,
 AuctionSearch auctionSearch)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionQuery - the auction query

auctionSearch - the auction search

Returns:

the returned search results

Throws:

NullArgumentException - auctionQuery or auctionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionQuery or auctionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionQueryFromInspector

AuctionQuery getAuctionQueryFromInspector(AuctionQueryInspector auctionQueryInspector)

Gets an auction query from an inspector. The inspector is available from an AuctionSearchResults .

Parameters:

auctionQueryInspector - an auction query inspector

Returns:

the auction query

Throws:

NullArgumentException - auctionQueryInspector is null

UnsupportedException - auctionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.