OSID - osid.calendaring.CalendarAdminSession Service Interface Definition

Interface	osid.calendaring.CalendarAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.batch.CalendarBatchAdminSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `Calendars`. 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 `Calendar`, a `CalendarForm` is requested using `getCalendarFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CalendarForm` 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 `CalendarForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CalendarForm` corresponds to an attempted transaction. For updates, `CalendarForms` are requested to the `Calendar` `Id` that is to be updated using `getCalendarFormForUpdate()`. Similarly, the `CalendarForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `Calendar` can only be used once for a successful update and cannot be reused. The delete operations delete `Calendars`.This session also includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateCalendars
Description	Tests if this user can create `Calendars`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Calendar` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Calendar` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCalendarWithRecordTypes
Description	Tests if this user can create a single `Calendar` using the desired record types. While `CalendaringManager.getCalendarRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Calendar`. Providing an empty array tests if a `Calendar` can be created with no records.
Parameters	`osid.type.Type[]`	`calendarRecordTypes`	array of calendar record types
Return	`boolean`		`true` if `Calendar` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`calendarRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarFormForCreate
Description	Gets the calendar form for creating new calendars. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`calendarRecordTypes`	array of calendar record types
Return	`osid.calendaring.CalendarForm`		the calendar form
Errors	NULL_ARGUMENT		`calendarRecordTypes` 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	createCalendar
Description	Creates a new `Calendar`.
Parameters	`osid.calendaring.CalendarForm`	`calendarForm`	the form for this `Calendar`
Return	`osid.calendaring.Calendar`		the new `Calendar`
Errors	ILLEGAL_STATE		`calendarForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`calendarForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`calendarForm` did not originate from `getCalendarFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCalendars
Description	Tests if this user can update `Calendars`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Calendar` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Calendar` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarFormForUpdate
Description	Gets the calendar form for updating an existing calendar. A new calendar form should be requested for each update transaction.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.CalendarForm`		the calendar form
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCalendar
Description	Updates an existing calendar.
Parameters	`osid.calendaring.CalendarForm`	`calendarForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`calendarForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`calendarForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`calendarForm` did not originate from `getCalendarFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCalendars
Description	Tests if this user can delete calendars. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Calendar` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Calendar` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCalendar
Description	Deletes a `Calendar`.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar` to remove
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCalendarAliases
Description	Tests if this user can manage `Id` aliases for `Calendars`. 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 `Calendar` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCalendar
Description	Adds an `Id` to a `Calendar` for the purpose of creating compatibility. The primary `Id` of the `Calendar` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another calendar, it is reassigned to the given calendar `Id`.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a `Calendar`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.