Interface | osid.calendaring.cycle.CyclicEventAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the Calendar associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCyclicEvents | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CyclicEvent creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCyclicEventWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | cyclicEventRecordTypes | array of cyclic event record types |
Return | boolean | true if CyclicEvent creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | cyclicEventRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventFormForCreate | ||
Description |
Gets the cyclic event form for creating new cyclic events. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | cyclicEventRecordTypes | array of cyclic event record types |
Return | osid.calendaring.cycle.CyclicEventForm | the cyclic event form | |
Errors | NULL_ARGUMENT | cyclicEventRecordTypes 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 | createCyclicEvent | ||
Description |
Creates a new | ||
Parameters | osid.calendaring.cycle.CyclicEventForm | cyclicEventForm | the form for this CyclicEvent |
Return | osid.calendaring.cycle.CyclicEvent | the new CyclicEvent | |
Errors | ILLEGAL_STATE | cyclicEventForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | cyclicEventForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicEventForm did not originate from
getCyclicEventFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCyclicEvents | ||
Description |
Tests if this user can update | ||
Return | boolean | false if cyclic event modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventFormForUpdate | ||
Description |
Gets the cyclic event form for updating an existing cyclic event. A new event form should be requested for each update transaction. | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent |
Return | osid.calendaring.cycle.CyclicEventForm | the cyclic event form | |
Errors | NOT_FOUND | cyclicEventId is not found | |
NULL_ARGUMENT | cyclicEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCyclicEvent | ||
Description |
Updates an existing cyclic event. | ||
Parameters | osid.calendaring.cycle.CyclicEventForm | cyclicEventForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | cyclicEventForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | cyclicEventForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicEventForm did not originate from
getCyclicEventFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCyclicEvents | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CyclicEvent deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCyclicEvent | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent to delete |
Errors | NOT_FOUND | a CyclicEvent was not found identified by the given
Id | |
NULL_ARGUMENT | cyclicEventId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCyclicEventAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CyclicEvent aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCyclicEvent | ||
Description |
Adds an | ||
Parameters | osid.id.Id | cyclicEventId | the Id of a CyclicEvent |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | cyclicEventId not found | ||
NULL_ARGUMENT | cyclicEventId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |