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

Interface	osid.calendaring.cycle.CyclicTimePeriodAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `CyclicTimePeriods.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `CyclicTimePeriod,` a `CyclicTimePeriodForm` is requested using `getCyclicTimePeriodFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CyclicTimePeriodForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `CyclicTimePeriodForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CyclicTimePeriodForm` corresponds to an attempted transaction. For updates, `CyclicTimePeriodForms` are requested to the `CyclicTimePeriod` `Id` that is to be updated using `getCyclicTimePeriodFormForUpdate().` Similarly, the `CyclicTimePeriodForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CyclicTimePeriodForm` can only be used once for a successful update and cannot be reused. The delete operations delete CyclicTimePeriodForms. To unmap a `CyclicTimePeriodFor` from the current `Calendar,` the `CyclicTimePeriodCalendarAssignmentSession` should be used. These delete operations attempt to remove the `CyclicTimePeriod` itself thus removing it from all known `Calendar` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateCyclicTimePeriods
Description	Tests if this user can create `CyclicTimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a CyclicTimePeriod will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `CyclicTimePeriod` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCyclicTimePeriodWithRecordTypes
Description	Tests if this user can create a single `CyclicTimePeriod` using the desired record types. While `CalendaringCycleManager.getCyclicTimePeriodRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CyclicTimePeriod.` Providing an empty array tests if a `CyclicTimePeriod` can be created with no records.
Parameters	`osid.type.Type[]`	`cyclicTimePeriodRecordTypes`	array of cyclic time period record types
Return	`boolean`		`true` if `CyclicTimePeriod` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicTimePeriodRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodFormForCreate
Description	Gets the cyclic time period form for creating new cyclic time periods. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`cyclicTimePeriodRecordTypes`	array of cyclic time period record types
Return	`osid.calendaring.cycle.CyclicTimePeriodForm`		the cyclic time period form
Errors	NULL_ARGUMENT		`cyclicTimePeriodRecordTypes` 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	createCyclicTimePeriod
Description	Creates a new `CyclicTimePeriod.`
Parameters	`osid.calendaring.cycle.CyclicTimePeriodForm`	`cyclicTimePeriodForm`	the forms for this `CyclicTimePeriod`
Return	`osid.calendaring.cycle.CyclicTimePeriod`		the new `CyclicTimePeriod`
Errors	ILLEGAL_STATE		`cyclicTimePeriodForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`cyclicTimePeriodForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicTimePeriodForm` did not originate from `getCyclicTimePeriodFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCyclicTimePeriods
Description	Tests if this user can update `CyclicTimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CyclicTimePeriod` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if cyclic time period modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodFormForUpdate
Description	Gets the cyclic time period form for updating an existing cyclic time period. A new cyclic time period form should be requested for each update transaction.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod`
Return	`osid.calendaring.cycle.CyclicTimePeriodForm`		the cyclic time period form
Errors	NOT_FOUND		`cyclicTimePeriodId` is not found
	NULL_ARGUMENT		`cyclicTimePeriodid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCyclicTimePeriod
Description	Updates an existing tiem period.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodForm`	`cyclicTimePeriodForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`cyclicTimePeriodForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`cyclicTimePeriodForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicTimePeriodForm` did not originate from `getCyclicTimePeriodFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCyclicTimePeriods
Description	Tests if this user can delete `CyclicTimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CyclicTimePeriod` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `CyclicTimePeriod` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCyclicTimePeriod
Description	Deletes the `CyclicTimePeriod` identified by the given `Id.`
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of the `CyclicTimePeriod` to delete
Errors	NOT_FOUND		a `CyclicTimePeriod` was not found identified by the given `Id`
	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCyclicTimePeriodAliases
Description	Tests if this user can manage `Id` aliases for `CyclicTimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `CyclicTimePeriod` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCyclicTimePeriod
Description	Adds an `Id` to a `CyclicTimePeriod` for the purpose of creating compatibility. The primary `Id` of the `CyclicTimePeriod` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another cyclic time period, it is reassigned to the given cyclic time period `Id.`
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the `Id` of a `CyclicTimePeriod`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`cyclicTimePeriodId` not found
	NULL_ARGUMENT		`cyclicTimePeriodId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.