org.osid.bidding

Interface AuctionQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AuctionSearchSession

public interface AuctionQuerySession
extends OsidSession

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

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
boolean	canSearchAuctions() Tests if this user can perform Auction lookups.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
AuctionQuery	getAuctionQuery() Gets an auction query.
AuctionList	getAuctionsByQuery(AuctionQuery auctionQuery) Gets a list of Auctions matching the given search.
void	useFederatedAuctionHouseView() Federates the view for methods in this session.
void	useIsolatedAuctionHouseView() Isolates the view for methods in this session.

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

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchAuctions

boolean canSearchAuctions()

Tests if this user can perform Auction lookups. 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.

useFederatedAuctionHouseView

void useFederatedAuctionHouseView()

Federates the view for methods in this session. A federated view will include auctions in auction houses which are children of this auction house in the auction house hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAuctionHouseView

void useIsolatedAuctionHouseView()

Isolates the view for methods in this session. An isolated view restricts searches to this auction house only.

Compliance:

mandatory - This method is must be implemented.

getAuctionQuery

AuctionQuery getAuctionQuery()

Gets an auction query.

Returns:

the auction query

Compliance:

mandatory - This method must be implemented.

getAuctionsByQuery

AuctionList getAuctionsByQuery(AuctionQuery auctionQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Auctions matching the given search.

Parameters:

auctionQuery - the auction query

Returns:

the returned AuctionList

Throws:

NullArgumentException - auctionQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionQuery is not of this service

Compliance:

mandatory - This method must be implemented.