| Interface | osid.bidding.rules.AuctionProcessorEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to apply | ||
| 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 | canAssignAuctionProcessorEnablers | ||
| Description |
Tests if this user can alter auction processor
enabler/auction processor mappings. A return of true does
not guarantee successful authorization. A return of false
indicates that it is known mapping methods in this session
will result in a | ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAuctionProcessorEnablerToAuctionProcessor | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auctionProcessorEnablerId | the Id of the AuctionProcessorEnabler |
osid.id.Id | auctionProcessorId | the Id of the AuctionProcessor | |
| Errors | ALREADY_EXISTS | auctionProcessorEnablerId already applied to
auctionProcessorId | |
| NOT_FOUND | auctionProcessorEnablerId or auctionProcessorId
not found | ||
| NULL_ARGUMENT | auctionProcessorEnablerId or auctionProcessorId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuctionProcessorEnablerFromAuctionProcessor | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | auctionProcessorEnablerId | the Id of the AuctionProcessorEnabler |
osid.id.Id | auctionProcessorId | the Id of the AuctionProcessor | |
| Errors | NOT_FOUND | auctionProcessorEnablerId or auctionProcessorId
not found or not mapped | |
| NULL_ARGUMENT | auctionProcessorEnablerId or auctionProcessorId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceAuctionProcessorEnablers | ||
| Description |
Tests if this user can order | ||
| Return | boolean | false if AuctionProcessorEnabler ordering is
not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuctionProcessorEnablerAhead | ||
| Description |
Reorders auction processor enablers for an auction processor by moving the specified auction processor enabler in front of a reference auction processor enabler. | ||
| Parameters | osid.id.Id | auctionProcessorEnablerId | the Id of an AuctionProcessorEnabler |
osid.id.Id | auctionProcessorId | the Id of an AuctionProcessor | |
osid.id.Id | referenceId | the reference auction processor Id | |
| Errors | NOT_FOUND | auctionProcessorEnablerId, auctionProcesorId, or
referenceId not found or, auctionProcessorEnablerId or
referenceId not related to auctionProcessorId | |
| NULL_ARGUMENT | auctionProcessorEnablerId, auctionProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuctionProcessorEnablerBehind | ||
| Description |
Reorders auction processor enablers for an auction processor by moving the specified auction processor enabler behind a reference auction processor enabler. | ||
| Parameters | osid.id.Id | auctionProcessorEnablerId | the Id of an AuctionProcessorEnabler |
osid.id.Id | auctionProcessorId | the Id of an AuctionProcessor | |
osid.id.Id | referenceId | the reference auction processor Id | |
| Errors | NOT_FOUND | auctionProcessorEnablerId, auctionProcesorId, or
referenceId not found or, auctionProcessorEnablerId or
referenceId not related to auctionProcessorId | |
| NULL_ARGUMENT | auctionProcessorEnablerId, auctionProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAuctionProcessorEnablers | ||
| Description |
Reorders a set of auction processor enablers for an auction processor. | ||
| Parameters | osid.id.Id[] | auctionProcessorEnablerIds | the Ids for a set of AuctionProcessorEnablers |
osid.id.Id | auctionProcessorId | the Id of an AuctionProcessor | |
| Errors | NOT_FOUND | auctionProcessorId not found or, an
auctionProcessorEnablerId not related to auctionProcessorId
| |
| NULL_ARGUMENT | auctionProcessorEnablerIds or auctionProcessorId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |