org.osid.bidding

Interface AuctionHouseQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AuctionHouseSearchSession

public interface AuctionHouseQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchAuctionHouses() Tests if this user can perform AuctionHouse searches.
AuctionHouseQuery	getAuctionHouseQuery() Gets an auction house query.
AuctionHouseList	getAuctionHousesByQuery(AuctionHouseQuery auctionHouseQuery) Gets a list of AuctionHouses matching the given search.

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

canSearchAuctionHouses

boolean canSearchAuctionHouses()

Tests if this user can perform AuctionHouse searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQuery

AuctionHouseQuery getAuctionHouseQuery()

Gets an auction house query.

Returns:

the auction house query

Compliance:

mandatory - This method must be implemented.

getAuctionHousesByQuery

AuctionHouseList getAuctionHousesByQuery(AuctionHouseQuery auctionHouseQuery)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a list of AuctionHouses matching the given search.

Parameters:

auctionHouseQuery - the auction query

Returns:

the returned AuctionHouseList

Throws:

NullArgumentException - auctionHouseQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionHouseQuery is not of this service

Compliance:

mandatory - This method must be implemented.