Interface | osid.bidding.rules.AuctionProcessorAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes auction processors. 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 | canCreateAuctionProcessor | ||
Description |
Tests if this user can create auction processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating an | ||
Return | boolean | false if AuctionProcessor creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuctionProcessorWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | auctionProcessorRecordTypes | array of auction processor record types |
Return | boolean | true if AuctionProcessor creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | auctionProcessorRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessorFormForCreate | ||
Description |
Gets the auction processor form for creating new auction processors. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | auctionProcessorRecordTypes | array of auction processor record types |
Return | osid.bidding.rules.AuctionProcessorForm | the auction processor form | |
Errors | NULL_ARGUMENT | auctionProcessorRecordTypes 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 | createAuctionProcessor | ||
Description |
Creates a new | ||
Parameters | osid.bidding.rules.AuctionProcessorForm | auctionProcessorForm | the form for this AuctionProcessor |
Return | osid.bidding.rules.AuctionProcessor | the new AuctionProcessor | |
Errors | ILLEGAL_STATE | auctionProcessorForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | auctionProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionProcessorForm did not originate from
getAuctionProcessorFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAuctionProcessors | ||
Description |
Tests if this user can update auction processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating an | ||
Return | boolean | false if AuctionProcessor modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionProcessorFormForUpdate | ||
Description |
Gets the auction processor form for updating an existing auction processor. A new auction processor form should be requested for each update transaction. | ||
Parameters | osid.id.Id | auctionProcessorId | the Id of the AuctionProcessor |
Return | osid.bidding.rules.AuctionProcessorForm | the auction processor form | |
Errors | NOT_FOUND | auctionProcessorId is not found | |
NULL_ARGUMENT | auctionProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuctionProcessor | ||
Description |
Updates an existing auction processor. | ||
Parameters | osid.bidding.rules.AuctionProcessorForm | auctionProcessorForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | auctionProcessorForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | auctionProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auctionProcessorForm did not originate from
getAuctionProcessorFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAuctionProcessors | ||
Description |
Tests if this user can delete auction processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting an | ||
Return | boolean | false if AuctionProcessor deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuctionProcessor | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | auctionProcessorId | the Id of the AuctionProcessor to remove |
Errors | NOT_FOUND | auctionProcessorId not found | |
NULL_ARGUMENT | auctionProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAuctionProcessorAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AuctionProcessor aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuctionProcessor | ||
Description |
Adds an | ||
Parameters | osid.id.Id | auctionProcessorId | the Id of an AuctionProcessor |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | auctionProcessorId not found | ||
NULL_ARGUMENT | auctionProcessorId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |