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

Interface	osid.calendaring.cycle.CyclicTimePeriodCalendarAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods to re-assign `CyclicTimePeriods` to `Calendars`. A `CyclicTimePeriod` may map to multiple `Calendars` and removing the last reference to a `CyclicTimePeriod` is the equivalent of deleting it. Each `Calendar` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of a `CyclicTimePeriod` to another `Calendar` is not a copy operation (eg: does not change its `Id`).
Method	canAssignCyclicTimePeriods
Description	Tests if this user can alter cyclic time period/calendar 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCyclicTimePeriodsToCalendar
Description	Tests if this user can alter cyclic time period/calendar 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 lookup operations to unauthorized users.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`calendarId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCalendarIds
Description	Gets a list of calendars including and under the given calendar node in which any cyclic time period can be assigned.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.id.IdList`		list of assignable calendar `Ids`
Errors	NULL_ARGUMENT		`calendarId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCalendarIdsForCyclicTimePeriod
Description	Gets a list of calendars including and under the given calendar node in which a specific cyclic time period can be assigned.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Return	`osid.id.IdList`		list of assignable calendar `Ids`
Errors	NULL_ARGUMENT		`calendarId` or `cyclicTimePeriodId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCyclicTimePeriodToCalendar
Description	Adds an existing `CyclicTimePeriod` to a `Calendar`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Errors	ALREADY_EXISTS		`cyclicTimePeriodId` is already assigned to `calendarId`
	NOT_FOUND		`cyclicTimePeriodId` or `calendarId` not found
	NULL_ARGUMENT		`cyclicTimePeriodId` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCyclicTimePeriodFromCalendar
Description	Removes a `CyclicTimePeriod` from a `Calendar`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Errors	NOT_FOUND		`cyclicTimePeriodId` or `calendarId` not found or `cyclicTimePeriodId` not assigned to `calendarId`
	NULL_ARGUMENT		`cyclicTimePeriodId` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCyclicTimePeriodToCalendar
Description	Moves a `CyclicTimePeriod` from one `Calendar` to another. Mappings to other `Calendars` are unaffected.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
	`osid.id.Id`	`fromCalendarId`	the `Id` of the current `Calendar`
	`osid.id.Id`	`toCalendarId`	the `Id` of the destination `Calendar`
Errors	ALREADY_EXISTS		`cyclicTimePeriodId` already assigned to `toCalendarId`
	NOT_FOUND		`cyclicTimePeriodId fromCalendarId`, or `toCalendarId` not found or `cyclicTimePeriodId` not mapped to `fromCalendarId`
	NULL_ARGUMENT		`cyclicTimePeriodId, fromCalendarId`, or `toCalendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.