Interface | osid.bidding.rules.AuctionConstrainerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes auction constrainers. The
data for create and update is provided via the | ||
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 | canCreateAuctionConstrainer | ||
Description |
Tests if this user can create auction constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating an | ||
Return | boolean | false if AuctionConstrainer creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuctionConstrainerWithRecordTypes | ||
Description |
| ||
Parameters | osid.type.Type[] | auctionConstrainerRecordTypes | array of auction constrainer record types |
Return | boolean | true if AuctionConstrainer creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | auctionConstrainerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionConstrainerFormForCreate | ||
Description |
Gets the auction constrainer form for creating new auction constrainers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | auctionConstrainerRecordTypes | array of auction constrainer record types |
Return | osid.bidding.rules.AuctionConstrainerForm | the auction constrainer form | |
Errors | NULL_ARGUMENT | auctionConstrainerRecordTypes 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 | createAuctionConstrainer | ||
Description |
Creates a new | ||
Parameters | osid.bidding.rules.AuctionConstrainerForm | auctionConstrainerForm | the form for this AuctionConstrainer |
Return | osid.bidding.rules.AuctionConstrainer | the new AuctionConstrainer | |
Errors | ILLEGAL_STATE | auctionConstrainerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | auctionConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionConstrainerForm did not originate from
getAuctionConstrainerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAuctionConstrainers | ||
Description |
Tests if this user can update auction constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating an | ||
Return | boolean | false if AuctionConstrainer modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionConstrainerFormForUpdate | ||
Description |
Gets the auction constrainer form for updating an existing auction constrainer. A new auction constrainer form should be requested for each update transaction. | ||
Parameters | osid.id.Id | auctionConstrainerId | the Id of the AuctionConstrainer |
Return | osid.bidding.rules.AuctionConstrainerForm | the auction constrainer form | |
Errors | NOT_FOUND | auctionConstrainerId is not found | |
NULL_ARGUMENT | auctionConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuctionConstrainer | ||
Description |
Updates an existing auction constrainer. | ||
Parameters | osid.bidding.rules.AuctionConstrainerForm | auctionConstrainerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | auctionConstrainerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | auctionConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionConstrainerForm did not originate from
getAuctionConstrainerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAuctionConstrainers | ||
Description |
Tests if this user can delete auction constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting an | ||
Return | boolean | false if AuctionConstrainer deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuctionConstrainer | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | auctionConstrainerId | the Id of the AuctionConstrainer to remove |
Errors | NOT_FOUND | auctionConstrainerId not found | |
NULL_ARGUMENT | auctionConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAuctionConstrainerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AuctionConstrainer aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuctionConstrainer | ||
Description |
Adds an | ||
Parameters | osid.id.Id | auctionConstrainerId | the Id of an AuctionConstrainer |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | auctionConstrainerId not found | ||
NULL_ARGUMENT | auctionConstrainerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |