Interface | osid.calendaring.cycle.EventCyclicEventAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to manually assign | ||
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 | canAssignEvents | ||
Description |
Tests if this user can alter event/cyclic event
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 | canAssignCyclicEventsToCyclicEvent | ||
Description |
Tests if this user can alter event/cyclic event 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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users. | ||
Parameters | osid.id.Id | cyclicEventId | the Id of the CyclicEvent |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | cyclicEventId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCyclicEventIds | ||
Description |
Gets a list of cyclic event | ||
Return | osid.id.IdList | list of assignable cyclic event Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | assignEventToCyclicEvent | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | eventId | the Id of the Event |
osid.id.Id | cyclicEventId | the Id of the CyclicEvent | |
Errors | ALREADY_EXISTS | eventId is already assigned to cyclicEventId | |
NOT_FOUND | eventId or cyclicEventId not found | ||
NULL_ARGUMENT | eventId or cyclicEventId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignEventFromCyclicEvent | ||
Description |
Removes an | ||
Parameters | osid.id.Id | eventId | the Id of the Event |
osid.id.Id | cyclicEventId | the Id of the CyclicEvent | |
Errors | NOT_FOUND | eventId or cyclicEventId not found or
eventId is not assigned to cyclicEventId | |
NULL_ARGUMENT | eventId or cyclicEventId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |