Interface | osid.bidding.BidLookupSession | ||
---|---|---|---|
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 | canLookupBids | ||
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 | useComparativeBidView | ||
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 | usePlenaryBidView | ||
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 bids 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 | useEffectiveBidView | ||
Description |
Only bids whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveBidView | ||
Description |
All bids of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBid | ||
Description |
Gets the In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | bidId | Id of the Bid |
Return | osid.bidding.Bid | the bid | |
Errors | NOT_FOUND | bidId not found | |
NULL_ARGUMENT | bidId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBidsByIds | ||
Description |
Gets a In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.IdList | bidIds | the list of Ids to retrieve |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | bidIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsByGenusType | ||
Description |
Gets a In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.type.Type | bidGenusType | a bid genus type |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NULL_ARGUMENT | bidGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsByParentGenusType | ||
Description |
Gets a In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.type.Type | bidGenusType | a bid genus type |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NULL_ARGUMENT | bidGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsByRecordType | ||
Description |
Gets a In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.type.Type | bidRecordType | a bid record type |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NULL_ARGUMENT | bidRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned Bid 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 | getBidsForAuction | ||
Description |
Gets a list of bids for an auction. 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 effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NULL_ARGUMENT | auctionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsForAuctionOnDate | ||
Description |
Gets a list of bids for an auction and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | auctionId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsForBidder | ||
Description |
Gets a list of bids for a bidder. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.bidding.BidList | the returned C ommission 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 | getBidsForBidderOnDate | ||
Description |
Gets a list of bids for a bidder and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned C ommission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsForAuctionAndBidder | ||
Description |
Gets a list of bids for an auction and bidder. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.bidding.BidList | the returned C ommission list | |
Errors | NULL_ARGUMENT | auctionId or resourceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidsForAuctionAndBidderOnDate | ||
Description |
Gets a list of bids for an auction and bidder and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
osid.id.Id | resourceId | a resource Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned C ommission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | auctionId, resourceId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWinningBids | ||
Description |
Gets all winning In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Return | osid.bidding.BidList | a list of Bids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWinningBidsOnDate | ||
Description |
Gets a list of all winning bids effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In both cases, the order of the set is by the start of the effective date. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned Bid 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 | getWinningBidsForAuction | ||
Description |
Gets a list of all winning bids for an auction. 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 effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | NULL_ARGUMENT | auctionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWinningBidsForAuctionOnDate | ||
Description |
Gets a list of winning bids for an auction and effectiveduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | auctionId | an auction Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned Bid list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | auctionId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWinningBidsForBidder | ||
Description |
Gets a list of all winning bids for a bidder. 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 effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resourceId Id |
Return | osid.bidding.BidList | the returned Bid 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 | getWinningBidsForBidderOnDate | ||
Description |
Gets a list of winning bids for a bidder and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.bidding.BidList | the returned C ommission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBids | ||
Description |
Gets all In plenary mode, the returned list contains all known bids or an error results. Otherwise, the returned list may contain only those bids that are accessible through this session. In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned. | ||
Return | osid.bidding.BidList | a list of Bids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |