| Interface | osid.resourcing.rules.CommissionEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to apply   | ||
| Method | getFoundryId | ||
| Description | 
                     Gets the   | ||
| Return | osid.id.Id | the  Foundry Id  associated with this session  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFoundry | ||
| Description | 
                     Gets the   | ||
| Return | osid.resourcing.Foundry | the foundry | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignCommissionEnablers | ||
| Description | 
                     Tests if this user can alter commission 
                    enabler/commission 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 | assignCommissionEnablerToCommission | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | commissionEnablerId | the  Id  of the  CommissionEnabler   | 
osid.id.Id | commissionId | the  Id  of the  Commission   | |
| Errors | ALREADY_EXISTS |  commissionEnablerId  is already applied to  
commissionId   |                 |
| NOT_FOUND |  commissionEnablerId  or  commissionId  not found  |                 ||
| NULL_ARGUMENT |  commissionEnablerId  or  commissionId  is  
null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignCommissionEnablerFromCommission | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | commissionEnablerId | the  Id  of the  CommissionEnabler   | 
osid.id.Id | commissionId | the  Id  of the  Commission   | |
| Errors | NOT_FOUND |  commissionEnablerId  or  commissionId  not found 
or  commissionEnablerId  not applied to  commissionId 
  |                 |
| NULL_ARGUMENT |  commissionEnablerId  or  commissionId  is  
null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceCommissionEnablers | ||
| Description | 
                     Tests if this user can order   | ||
| Return | boolean |  false  if  CommissionEnabler  ordering is not 
authorized,  true  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveCommissionEnablerAhead | ||
| Description | 
                     Reorders commission enablers for a commission by moving the specified commission enabler in front of a reference commission enabler.  | ||
| Parameters | osid.id.Id | commissionEnablerId | the  Id  of a  CommissionEnabler   | 
osid.id.Id | commissionId | the  Id  of a  Commission   | |
osid.id.Id | referenceId | the reference commission enabler  Id   | |
| Errors | NOT_FOUND |  commissionEnablerId, commissionId,  or  referenceId 
 not found or,  commissionEnablerId  or  referenceId 
 not related to  commissionId   |                 |
| NULL_ARGUMENT |  commissionEnablerId,commissionId,  or  referenceId 
 is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveCommissionEnablerBehind | ||
| Description | 
                     Reorders commission enablers for a commission by moving the specified commission enabler behind a reference commission enabler.  | ||
| Parameters | osid.id.Id | commissionEnablerId | the  Id  of a  CommissionEnabler   | 
osid.id.Id | commissionId | the  Id  of a  Commission   | |
osid.id.Id | referenceId | the reference commission enabler  Id   | |
| Errors | NOT_FOUND |  commissionEnablerId, commissionId,  or  referenceId 
 not found or,  commissionEnablerId  or  referenceId 
 not related to  commissionId   |                 |
| NULL_ARGUMENT |  commissionEnablerId,commissionId,  or  referenceId 
 is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCommissionEnablers | ||
| Description | 
                     Reorders a set of commission enablers for a commission.  | ||
| Parameters | osid.id.Id[] | commissionEnablerIds | the  Ids  for a set of  CommissionnEnablers   | 
osid.id.Id | commissionId | the  Id  of a  Commission   | |
| Errors | NOT_FOUND |  commissionId  not found or, a  commissionEnablerId 
 not related to  commissionId   |                 |
| NULL_ARGUMENT |  commissionEnablerIds  or  commissionId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |