Interface | osid.bidding.AuctionHouseAdminSession | ||
---|---|---|---|
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 | ||
Method | canCreateAuctionHouses | ||
Description |
Tests if this user can create | ||
Return | boolean | false if AuctionHouse creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuctionHouseWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | auctionHouseRecordTypes | array of auction house record types |
Return | boolean | true if AuctionHouse creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | auctionHouseRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouseFormForCreate | ||
Description |
Gets the auction house form for creating new auction houses. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | auctionHouseRecordTypes | array of auction house record types |
Return | osid.bidding.AuctionHouseForm | the auction house form | |
Errors | NULL_ARGUMENT | auctionHouseRecordTypes 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 | createAuctionHouse | ||
Description |
Creates a new | ||
Parameters | osid.bidding.AuctionHouseForm | auctionHouseForm | the form for this AuctionHouse |
Return | osid.bidding.AuctionHouse | the new AuctionHouse | |
Errors | ILLEGAL_STATE | auctionHouseForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | auctionHouseForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionHouseForm did not originate from
getAuctionHouseFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAuctionHouses | ||
Description |
Tests if this user can update | ||
Return | boolean | false if AuctionHouse modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouseFormForUpdate | ||
Description |
Gets the auction house form for updating an existing auction house. A new auction house form should be requested for each update transaction. | ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse |
Return | osid.bidding.AuctionHouseForm | the auction house form | |
Errors | NOT_FOUND | auctionHouseId is not found | |
NULL_ARGUMENT | auctionHouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuctionHouse | ||
Description |
Updates an existing auction house | ||
Parameters | osid.bidding.AuctionHouseForm | auctionHouseForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | auctionHouseForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | auctionHouseForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionHouseForm did not originate from
getAuctionHouseFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAuctionHouses | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if AuctionHouse deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuctionHouse | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | auctionHouseId | the Id of the AuctionHouse to remove |
Errors | NOT_FOUND | auctionHouseId not found | |
NULL_ARGUMENT | auctionHouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAuctionHouseAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AuctionHouse aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuctionHouse | ||
Description |
Adds an | ||
Parameters | osid.id.Id | auctionHouseId | the Id of an AuctionHouse |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | auctionHouseId not found | ||
NULL_ARGUMENT | auctionHouseId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |