Interface AuctionConstrainerEnablerSearchSession

All Superinterfaces:

AuctionConstrainerEnablerQuerySession, AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 AuctionConstrainerEnablerQuerySession

canSearchAuctionConstrainerEnablers, getAuctionConstrainerEnablerQuery, getAuctionConstrainerEnablersByQuery, getAuctionHouse, getAuctionHouseId, useFederatedAuctionHouseView, useIsolatedAuctionHouseView

Modifier and Type	Method	Description
boolean	canSearchAuctionConstrainerEnablers()	Tests if this user can perform AuctionConstrainerEnabler lookups.
AuctionConstrainerEnablerQuery	getAuctionConstrainerEnablerQuery()	Gets an auction constrainer enabler query.
AuctionConstrainerEnablerList	getAuctionConstrainerEnablersByQuery(AuctionConstrainerEnablerQuery auctionConstrainerEnablerQuery)	Gets a list of AuctionConstrainerEnablers matching the given search.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
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

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.