org.osid.bidding.rules

Interface AuctionProcessorEnablerSearchSession

All Superinterfaces:

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

public interface AuctionProcessorEnablerSearchSession
extends AuctionProcessorEnablerQuerySession

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

getAuctionProcessorEnablersByQuery() is the basic search method and returns a list of AuctionProcessorEnablers. A more advanced search may be performed with getAuctionProcessorEnablersBySearch(). It accepts an AuctionProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as bidding. getAuctionProcessorEnablersBySearch() returns an AuctionProcessorEnablerSearchResults that can be used to access the resulting AuctionProcessorEnablerList or be used to perform a search within the result set through AuctionProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated auction house view: searches include auction processor 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 auction processor enablers in this auction house

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

Method Summary

Methods

Modifier and Type	Method and Description
AuctionProcessorEnablerQuery	getAuctionProcessorEnablerQueryFromInspector(AuctionProcessorEnablerQueryInspector auctionProcessorEnablerQueryInspector) Gets an auction processor enabler query from an inspector.
AuctionProcessorEnablerSearchResults	getAuctionProcessorEnablersBySearch(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery, AuctionProcessorEnablerSearch auctionProcessorEnablerSearch) Gets the search results matching the given search query using the given search.
AuctionProcessorEnablerSearch	getAuctionProcessorEnablerSearch() Gets an auction processor enabler search.
AuctionProcessorEnablerSearchOrder	getAuctionProcessorEnablerSearchOrder() Gets an auction processor enabler search order.

Methods inherited from interface org.osid.bidding.rules.AuctionProcessorEnablerQuerySession

canSearchAuctionProcessorEnablers, getAuctionHouse, getAuctionHouseId, getAuctionProcessorEnablerQuery, getAuctionProcessorEnablersByQuery, 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

getAuctionProcessorEnablerSearch

AuctionProcessorEnablerSearch getAuctionProcessorEnablerSearch()

Gets an auction processor enabler search.

Returns:

the auction processor enabler search

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerSearchOrder

AuctionProcessorEnablerSearchOrder getAuctionProcessorEnablerSearchOrder()

Gets an auction processor enabler search order. The AuctionProcessorEnablerSearchOrder is supplied to an AuctionProcessorEnablerSearch to specify the ordering of results.

Returns:

the auction processor enabler search order

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablersBySearch

AuctionProcessorEnablerSearchResults getAuctionProcessorEnablersBySearch(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery,
                                                                       AuctionProcessorEnablerSearch auctionProcessorEnablerSearch)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

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

Parameters:

auctionProcessorEnablerQuery - the auction processor enabler query

auctionProcessorEnablerSearch - the auction processor enabler search

Returns:

the returned search results

Throws:

NullArgumentException - auctionProcessorEnablerQuery or auctionProcessorEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionProcessorEnablerQuery or auctionProcessorEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerQueryFromInspector

AuctionProcessorEnablerQuery getAuctionProcessorEnablerQueryFromInspector(AuctionProcessorEnablerQueryInspector auctionProcessorEnablerQueryInspector)

Gets an auction processor enabler query from an inspector. The inspector is available from an AuctionProcessorEnablerSearchResults.

Parameters:

auctionProcessorEnablerQueryInspector - an auction processor enabler query inspector

Returns:

the auction processor enabler query

Throws:

NullArgumentException - auctionProcessorEnablerQueryInspector is null

UnsupportedException - auctionProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.