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

Interface	osid.calendaring.cycle.TimePeriodCyclicTimePeriodAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods to manually assign `TimePeriods` to `CyclicTimePeriods`.
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	canAssignTimePeriods
Description	Tests if this user can alter time period/cyclic time period 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	canAssignCyclicTimePeriodsToCyclicTimePeriod
Description	Tests if this user can alter time period/cyclic time period 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`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableCyclicTimePeriodIds
Description	Gets a list of cyclic time period `Ids`.
Return	`osid.id.IdList`		list of assignable cyclic time period `Ids`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignTimePeriodToCyclicTimePeriod
Description	Adds an existing `TimePeriod` to a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod`
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Errors	ALREADY_EXISTS		`timePeriodId` is alrteady assigned to `cyclicTimePeriodId`
	NOT_FOUND		`timePeriodId` or `cyclicTimePeriodId` not found
	NULL_ARGUMENT		`timePeriodId` or `cyclicTimePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignTimePeriodFromCyclicTimePeriod
Description	Removes a `TimePeriod` from a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod`
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Errors	NOT_FOUND		`timePeriodId` or `cyclicTimePeriodId` not found or `timePeriodId` is not asigned to `cyclicTimePeriodId`
	NULL_ARGUMENT		`timePeriodId` or `cyclicTimePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.