Interface | osid.bidding.rules.AuctionProcessorLookupSession | ||
---|---|---|---|
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 | canLookupAuctionProcessors | ||
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 | useComparativeAuctionProcessorView | ||
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 | usePlenaryAuctionProcessorView | ||
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 auction processor 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 | useActiveAuctionProcessorView | ||
Description |
Only active auction processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusAuctionProcessorView | ||
Description |
All active and inactive auction processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAuctionProcessor | ||
Description |
Gets the In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Parameters | osid.id.Id | auctionProcessorId | Id of the AuctionProcessor |
Return | osid.bidding.rules.AuctionProcessor | the auction processor | |
Errors | NOT_FOUND | auctionProcessorId not found | |
NULL_ARGUMENT | auctionProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAuctionProcessorsByIds | ||
Description |
Gets an In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Parameters | osid.id.IdList | auctionProcessorIds | the list of Ids to retrieve |
Return | osid.bidding.rules.AuctionProcessorList | the returned AuctionProcessor list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | auctionProcessorIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessorsByGenusType | ||
Description |
Gets an In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Parameters | osid.type.Type | auctionProcessorGenusType | an auction processor genus type |
Return | osid.bidding.rules.AuctionProcessorList | the returned AuctionProcessor list | |
Errors | NULL_ARGUMENT | auctionProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessorsByParentGenusType | ||
Description |
Gets an In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Parameters | osid.type.Type | auctionProcessorGenusType | an auction processor genus type |
Return | osid.bidding.rules.AuctionProcessorList | the returned AuctionProcessor list | |
Errors | NULL_ARGUMENT | auctionProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessorsByRecordType | ||
Description |
Gets an In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Parameters | osid.type.Type | auctionProcessorRecordType | an auction processor record type |
Return | osid.bidding.rules.AuctionProcessorList | the returned AuctionProcessor list | |
Errors | NULL_ARGUMENT | auctionProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessors | ||
Description |
Gets all In plenary mode, the returned list contains all known auction processor or an error results. Otherwise, the returned list may contain only those auction processor that are accessible through this session. In active mode, auction processors are returned that are currently active. In any status mode, active and inactive auction processors are returned. | ||
Return | osid.bidding.rules.AuctionProcessorList | the returned AuctionProcessor list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |