| Interface | osid.rules.check.AgendaEngineAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignAgendas | ||
| Description |
Tests if this user can alter agenda/engine 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 check is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAgendasToEngine | ||
| Description |
Tests if this user can alter agenda/engine 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
| ||
| Parameters | osid.id.Id | engineId | the Id of the Engine |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | engineId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableEngineIds | ||
| Description |
Gets a list of engines including and under the given engine node in which any agenda can be assigned. | ||
| Parameters | osid.id.Id | engineId | the Id of the Engine |
| Return | osid.id.IdList | list of assignable engine Ids | |
| Errors | NULL_ARGUMENT | engineId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableEngineIdsForAgenda | ||
| Description |
Gets a list of engines including and under the given engine node in which a specific agenda can be assigned. | ||
| Parameters | osid.id.Id | engineId | the Id of the Engine |
osid.id.Id | agendaId | the Id of the Agenda | |
| Return | osid.id.IdList | list of assignable engine Ids | |
| Errors | NULL_ARGUMENT | engineId or agendaId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAgendaToEngine | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | agendaId | the Id of the Agenda |
osid.id.Id | engineId | the Id of the Engine | |
| Errors | ALREADY_EXISTS | agendaId is already assigned to engineId | |
| NOT_FOUND | agendaId or engineId not found | ||
| NULL_ARGUMENT | agendaId or engineId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAgendaFromEngine | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | agendaId | the Id of the Agenda |
osid.id.Id | engineId | the Id of the Engine | |
| Errors | NOT_FOUND | agendaId or engineId not found or
agendaId not assigned to engineId | |
| NULL_ARGUMENT | agendaId or engineId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |