Interface | osid.bidding.AuctionAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
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 | canCreateAuctions | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Auction creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuctionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | auctionRecordTypes | array of auction record types |
Return | boolean | true if Auction creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | auctionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionFormForCreate | ||
Description |
Gets the auction form for creating new auctions. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | auctionRecordTypes | array of auction record types |
Return | osid.bidding.AuctionForm | the auction form | |
Errors | NULL_ARGUMENT | auctionRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAuction | ||
Description |
Creates a new | ||
Parameters | osid.bidding.AuctionForm | auctionForm | the form for this Auction |
Return | osid.bidding.Auction | the new Auction | |
Errors | ILLEGAL_STATE | auctionForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | auctionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionForm did not originate from
getAuctionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAuctions | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Auction modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionFormForUpdate | ||
Description |
Gets the auction form for updating an existing auction. A new auction form should be requested for each update transaction. | ||
Parameters | osid.id.Id | auctionId | the Id of the Auction |
Return | osid.bidding.AuctionForm | the auction form | |
Errors | NOT_FOUND | auctionId is not found | |
NULL_ARGUMENT | auctionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuction | ||
Description |
Updates an existing auction. | ||
Parameters | osid.bidding.AuctionForm | auctionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | auctionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | auctionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionForm did not originate from
getAuctionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAuctions | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Auction deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuction | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | auctionId | the Id of the Auction to remove |
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 must be implemented. | |
Method | canManageAuctionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Auction aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuction | ||
Description |
Adds an | ||
Parameters | osid.id.Id | auctionId | the Id of an Auction |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | auctionId not found | ||
NULL_ARGUMENT | auctionId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |