Interface | osid.bidding.AuctionLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupAuctions | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAuctionView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryAuctionView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 lookups to this auction house only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveAuctionView | ||
Description |
Only active auctions are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusAuctionView | ||
Description |
Active and inactive auctions are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAuction | ||
Description |
Gets the In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.id.Id | auctionId | Id of the Auction |
Return | osid.bidding.Auction | the auction | |
Errors | NOT_FOUND | auctionId not found | |
NULL_ARGUMENT | auctionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAuctionsByIds | ||
Description |
Gets an In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.id.IdList | auctionIds | the list of Ids to retrieve |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | auctionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByGenusType | ||
Description |
Gets an In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.type.Type | auctionGenusType | an auction genus type |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | auctionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByParentGenusType | ||
Description |
Gets an In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.type.Type | auctionGenusType | an auction genus type |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | auctionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByRecordType | ||
Description |
Gets an In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.type.Type | auctionRecordType | an auction record type |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | auctionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByProvider | ||
Description |
Gets an In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByItem | ||
Description |
Gets a list of auctions for an item. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.id.Id | itemId | a resource Id |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | itemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByItemGenusType | ||
Description |
Gets a list of auctions for an item genus type. In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.type.Type | itemGenusType | an item genus type |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | NULL_ARGUMENT | itemGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionsByItemGenusTypeOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Parameters | osid.type.Type | itemGenusType | an item genus type |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.AuctionList | the returned Auction list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | itemGenusType, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctions | ||
Description |
Gets all In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned. | ||
Return | osid.bidding.AuctionList | a list of Auctions | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |