org.osid.bidding

Interface AuctionSearchSession

All Superinterfaces:

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

public interface AuctionSearchSession
extends AuctionQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.bidding.AuctionQuerySession

canSearchAuctions, getAuctionHouse, getAuctionHouseId, getAuctionQuery, getAuctionsByQuery, 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

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.