| Interface | osid.bidding.AuctionAuctionHouseAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignAuctions | ||
| Description |
Tests if this user can alter auction/auction house
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAuctionsToAuctionHouse | ||
| Description |
Tests if this user can alter auction/auction house
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | auctionHouseId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableAuctionHouseIds | ||
| Description |
Gets a list of auction houses including and under the given auction house node in which any auction can be assigned. | ||
| Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse |
| Return | osid.id.IdList | list of assignable auction house Ids | |
| Errors | NULL_ARGUMENT | auctionHouseId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableAuctionHouseIdsForAuction | ||
| Description |
Gets a list of auction houses including and under the given auction house node in which a specific auction can be assigned. | ||
| Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse |
osid.id.Id | auctionId | the Id of the Auction | |
| Return | osid.id.IdList | list of assignable auction house Ids | |
| Errors | NULL_ARGUMENT | auctionHouseId or auctionId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAuctionToAuctionHouse | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auctionId | the Id of the Auction |
osid.id.Id | auctionHouseId | the Id of the AuctionHouse | |
| Errors | ALREADY_EXISTS | auctionId is already assigned to auctionHouseId
| |
| NOT_FOUND | auctionId or auctionHouseId not found | ||
| NULL_ARGUMENT | auctionId or auctionHouseId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuctionFromAuctionHouse | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | auctionId | the Id of the Auction |
osid.id.Id | auctionHouseId | the Id of the AuctionHouse | |
| Errors | NOT_FOUND | auctionId or auctionHouseId not found or
auctionId not assigned to auctionHouseId | |
| NULL_ARGUMENT | auctionId or auctionHouseId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignAuctionToAuctionHouse | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | auctionId | the Id of the Auction |
osid.id.Id | fromAuctionHouseId | the Id of the current AuctionHouse | |
osid.id.Id | toAuctionHouseId | the Id of the destination AuctionHouse | |
| Errors | NOT_FOUND | auctionId, fromAuctionHouseId, or toAuctionHouseId
not found or auctionId not mapped to
fromAuctionHouseId | |
| NULL_ARGUMENT | auctionId, fromAuctionHouseId, or toAuctionHouseId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |