Interface | osid.bidding.BidAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a 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 | canCreateBids | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Bid creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBidWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | bidRecordTypes | array of bid record types |
Return | boolean | true if Bid creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | bidRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidFormForCreate | ||
Description |
Gets the bid form for creating new bids. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | auctionId | an Auction Id |
osid.type.Type[] | bidRecordTypes | array of bid record types | |
Return | osid.bidding.BidForm | the bid form | |
Errors | NOT_FOUND | auctionId is not found | |
NULL_ARGUMENT | auctionId or bidRecordTypes 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 | createBid | ||
Description |
Creates a new | ||
Parameters | osid.bidding.BidForm | bidForm | the form for this Bid |
Return | osid.bidding.Bid | the new Bid | |
Errors | ILLEGAL_STATE | bidForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | bidForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | bidForm did not originate from getBidFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBids | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Bid modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidFormForUpdate | ||
Description |
Gets the bid form for updating an existing bid. A new bid form should be requested for each update transaction. | ||
Parameters | osid.id.Id | bidId | the Id of the Bid |
Return | osid.bidding.BidForm | the bid form | |
Errors | NOT_FOUND | bidId is not found | |
NULL_ARGUMENT | bidId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBid | ||
Description |
Updates an existing bid. | ||
Parameters | osid.bidding.BidForm | bidForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | bidForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | bidForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | bidForm did not originate from getBidFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBids | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Bid deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBid | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | bidId | the Id of the Bid to remove |
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 must be implemented. | |
Method | canManageBidAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Bid aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBid | ||
Description |
Adds an | ||
Parameters | osid.id.Id | bidId | the Id of a Bid |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | bidId not found | ||
NULL_ARGUMENT | bidId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |