OSID - osid.calendaring.cycle.EventCyclicEventAssignmentSession Service Interface Definition

Interface	osid.calendaring.cycle.EventCyclicEventAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods to manually assign `Events` to `CyclicEvents`. An `Event` may be the product of a `OsidRule` originating from a `SupersedingEvent`, `OffsetEvent`, or a `RecurringEvent` in which case the `CyclicEvent` is applied to the rule.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	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 `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
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 `Ids`.
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 `Event` to a `CyclicEvent`.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event`
Parameters	`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 `Event` from a `CyclicEvent`.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event`
Parameters	`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.