Interface | osid.rules.check.AgendaAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getEngineId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Engine Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngine | ||
Description |
Gets the | ||
Return | osid.rules.Engine | the engine | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAgendas | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Agenda creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAgendaWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | agendaRecordTypes | array of agenda record types |
Return | boolean | true if Agenda creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | agendaRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgendaFormForCreate | ||
Description |
Gets the agenda form for creating new agendas. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | agendaRecordTypes | array of agenda record types |
Return | osid.rules.check.AgendaForm | the agenda form | |
Errors | NULL_ARGUMENT | agendaRecordTypes 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 | createAgenda | ||
Description |
Creates a new | ||
Parameters | osid.rules.check.AgendaForm | agendaForm | the form for this Agenda |
Return | osid.rules.check.Agenda | the new Agenda | |
Errors | ILLEGAL_STATE | agendaForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | agendaForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | agendaForm did not originate from
getAgendaFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAgendas | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Agenda modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgendaFormForUpdate | ||
Description |
Gets the agenda form for updating an existing agenda. A new agenda form should be requested for each update transaction. | ||
Parameters | osid.id.Id | agendaId | the Id of the Agenda |
Return | osid.rules.check.AgendaForm | the agenda form | |
Errors | NOT_FOUND | agendaId is not found | |
NULL_ARGUMENT | agendaId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAgenda | ||
Description |
Updates an existing agenda. | ||
Parameters | osid.rules.check.AgendaForm | agendaForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | agendaForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | agendaForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | agendaForm did not originate from
getAgendaFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAgendas | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Agenda deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAgenda | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | agendaId | the Id of the Agenda to remove |
Errors | NOT_FOUND | agendaId not found | |
NULL_ARGUMENT | agendaId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAgendaAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Agenda aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAgenda | ||
Description |
Adds an | ||
Parameters | osid.id.Id | agendaId | the Id of an Agenda |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | agendaId not found | ||
NULL_ARGUMENT | agendaId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |