OSID - osid.calendaring.TimePeriodAdminSession Service Interface Definition

Interface	osid.calendaring.TimePeriodAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Time Periods.` 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 `TimePeriod,` a `TimePeriodForm` is requested using `getTimePeriodFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `TimePeriodForm` 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 `TimePeriodForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `TimePeriodForm` corresponds to an attempted transaction. For updates, `TimePeriodForms` are requested to the `TimePeriod` `Id` that is to be updated using `getTimePeriodFormForUpdate().` Similarly, the `TimePeriodForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `TimePeriodForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Time Periods.` To unmap a `TimePeriod` from the current `Calendar,` the `TimePeriodCalendarAssignmentSession` should be used. These delete operations attempt to remove the `TimePeriod` 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	canCreateTimePeriods
Description	Tests if this user can create `TimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a TimePeriod 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 `TimePeriod` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTimePeriodWithRecordTypes
Description	Tests if this user can create a single `TimePeriod` using the desired record types. While `CalendaringManager.getTimePeriodRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `TimePeriod.` Providing an empty array tests if a `TimePeriod` can be created with no records.
Parameters	`osid.type.Type[]`	`timePeriodRecordTypes`	array of time period record types
Return	`boolean`		`true` if `TimePeriod` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`timePeriodRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodFormForCreate
Description	Gets the time period form for creating new time periods. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`timePeriodRecordTypes`	array of time period record types
Return	`osid.calendaring.TimePeriodForm`		the time period form
Errors	NULL_ARGUMENT		`timePeriodRecordTypes` 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	createTimePeriod
Description	Creates a new `TimePeriod.`
Parameters	`osid.calendaring.TimePeriodForm`	`timePeriodForm`	the forms for this `TimePeriod`
Return	`osid.calendaring.TimePeriod`		the new `TimePeriod`
Errors	ILLEGAL_STATE		`timePeriodForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`timePeriodForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`timePeriodForm` did not originate from `getTimePeriodForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTimePeriods
Description	Tests if this user can update `TimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `TimePeriod` 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 time period modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodFormForUpdate
Description	Gets the time period form for updating an existing time period. A new time period form should be requested for each update transaction.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod`
Return	`osid.calendaring.TimePeriodForm`		the time period form
Errors	NOT_FOUND		`timePeriodId` is not found
	NULL_ARGUMENT		`timePeriodid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateTimePeriod
Description	Updates an existing tiem period.
Parameters	`osid.calendaring.TimePeriodForm`	`timePeriodForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`timePeriodForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`timePeriodForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`timePeriodForm` did not originate from `getTimePeriodForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTimePeriods
Description	Tests if this user can delete `TimePeriods.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `TimePeriod` 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 `TimePeriod` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteTimePeriod
Description	Deletes the `TimePeriod` identified by the given `Id.`
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod` to delete
Errors	NOT_FOUND		a `TimePeriod` was not found identified by the given `Id`
	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTimePeriodAliases
Description	Tests if this user can manage `Id` aliases for `TimePeriods.` 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 `TimePeriod` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasTimePeriod
Description	Adds an `Id` to a `TimePeriod` for the purpose of creating compatibility. The primary `Id` of the `TimePeriod` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another time period, it is reassigned to the given time period `Id.`
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of a `TimePeriod`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`timePeriodId` not found
	NULL_ARGUMENT		`timePeriodId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addExceptionEvent
Description	Adds an exception event to a time period. Time period exception events govern exceptions to recurring events mapped to a time period.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of a `TimePeriod`
Parameters	`osid.id.Id`	`eventId`	an exception event `Id`
Errors	ALREADY_EXISTS		event is already part of the time period
	NOT_FOUND		`timePeriodId` or `eventId` is not found
	NULL_ARGUMENT		`timePeriodId` or `eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeExceptionEvent
Description	Removes an exception event from a time period.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of a `TimePeriod`
Parameters	`osid.id.Id`	`eventId`	an exception event `Id`
Errors	NOT_FOUND		`eventId` not an exception in `timePeriodId`
	NULL_ARGUMENT		`timePeriodId` or `eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.