Interface | osid.bidding.AuctionQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Auctions may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAuctionHouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the AuctionHouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouse | ||
Description |
Gets the | ||
Return | osid.bidding.AuctionHouse | the auction house | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchAuctions | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedAuctionHouseView | ||
Description |
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. | |
Method | useIsolatedAuctionHouseView | ||
Description |
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. | |
Method | getAuctionQuery | ||
Description |
Gets an auction query. | ||
Return | osid.bidding.AuctionQuery | the auction query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.bidding.AuctionQuery | auctionQuery | the auction query |
Return | osid.bidding.AuctionList | the returned AuctionList | |
Errors | NULL_ARGUMENT | auctionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |