org.osid.bidding.rules

Interface AuctionConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface AuctionConstrainerEnablerSearchSession
extends AuctionConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AuctionConstrainerEnablerQuery	getAuctionConstrainerEnablerQueryFromInspector(AuctionConstrainerEnablerQueryInspector auctionConstrainerEnablerQueryInspector) Gets an auction constrainer enabler query from an inspector.
AuctionConstrainerEnablerSearchResults	getAuctionConstrainerEnablersBySearch(AuctionConstrainerEnablerQuery auctionConstrainerEnablerQuery, AuctionConstrainerEnablerSearch auctionConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
AuctionConstrainerEnablerSearch	getAuctionConstrainerEnablerSearch() Gets an auction constrainer enabler search.
AuctionConstrainerEnablerSearchOrder	getAuctionConstrainerEnablerSearchOrder() Gets an auction constrainer enabler search order.

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

canSearchAuctionConstrainerEnablers, getAuctionConstrainerEnablerQuery, getAuctionConstrainerEnablersByQuery, getAuctionHouse, getAuctionHouseId, 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

getAuctionConstrainerEnablerSearch

AuctionConstrainerEnablerSearch getAuctionConstrainerEnablerSearch()

Gets an auction constrainer enabler search.

Returns:

the auction constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerSearchOrder

AuctionConstrainerEnablerSearchOrder getAuctionConstrainerEnablerSearchOrder()

Gets an auction constrainer enabler search order. The AuctionConstrainerEnablerSearchOrder is supplied to an AuctionConstrainerEnablerSearch to specify the ordering of results.

Returns:

the auction constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablersBySearch

AuctionConstrainerEnablerSearchResults getAuctionConstrainerEnablersBySearch(AuctionConstrainerEnablerQuery auctionConstrainerEnablerQuery,
                                                                           AuctionConstrainerEnablerSearch auctionConstrainerEnablerSearch)
                                                                             throws OperationFailedException,
                                                                                    PermissionDeniedException

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

Parameters:

auctionConstrainerEnablerQuery - the auction constrainer enabler query

auctionConstrainerEnablerSearch - the auction constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - auctionConstrainerEnablerQuery or auctionConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionConstrainerEnablerQuery or auctionConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerQueryFromInspector

AuctionConstrainerEnablerQuery getAuctionConstrainerEnablerQueryFromInspector(AuctionConstrainerEnablerQueryInspector auctionConstrainerEnablerQueryInspector)

Gets an auction constrainer enabler query from an inspector. The inspector is available from an AuctionConstrainerEnablerSearchResults.

Parameters:

auctionConstrainerEnablerQueryInspector - an auction constrainer enabler query inspector

Returns:

the auction constrainer enabler query

Throws:

NullArgumentException - auctionConstrainerEnablerQueryInspector is null

UnsupportedException - auctionConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.