org.osid.bidding

Interface BidQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

BidSearchSession

public interface BidQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

• federated auction house view: searches include bids in auction houses of which this auction house is an ancestor in the auction house hierarchy
• isolated auction house view: searches are restricted to bids in this auction house

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchBids() Tests if this user can perform Bid lookups.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
BidQuery	getBidQuery() Gets a bid query.
BidList	getBidsByQuery(BidQuery bidQuery) Gets a list of Bids 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.

canSearchBids

boolean canSearchBids()

Tests if this user can perform Bid 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 bids 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.

getBidQuery

BidQuery getBidQuery()

Gets a bid query.

Returns:

the bid query

Compliance:

mandatory - This method must be implemented.

getBidsByQuery

BidList getBidsByQuery(BidQuery bidQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Gets a list of Bids matching the given search.

Parameters:

bidQuery - the search query

Returns:

the returned BidList

Throws:

NullArgumentException - bidQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - bidQuery is not of this service

Compliance:

mandatory - This method must be implemented.