OSID - osid.resourcing.AvailabilityAdminSession Service Interface Definition

Interface	osid.resourcing.AvailabilityAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Availabilities.` 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 an `Availability,` an `AvailabilityForm` is requested using `getAvailabilityFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `AvailabilityForm` 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 `AvailabilityForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AvailabilityForm` corresponds to an attempted transaction. For updates, `AvailabilityForms` are requested to the `Availability` `Id` that is to be updated using `getAvailabilityFormForUpdate().` Similarly, the `AvailabilityForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AvailabilityForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Availabilities.` To unmap an `Availability` from the current `Foundry,` the `AvailabilityFoundryAssignmentSession` should be used. These delete operations attempt to remove the `Availability` itself thus removing it from all known `Foundry` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAvailabilities
Description	Tests if this user can create `Availabilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Availability` 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 `Availability` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAvailabilityWithRecordTypes
Description	Tests if this user can create a single `Availability` using the desired record types. While `ResourcingManager.getAvailabilityRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Availability.` Providing an empty array tests if an `Availability` can be created with no records.
Parameters	`osid.type.Type[]`	`availabilityRecordTypes`	array of availability record types
Return	`boolean`		`true` if `Availability` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`availabilityRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityFormForCreate
Description	Gets the availability form for creating new availabilities. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	the `Id` for the resource
	`osid.id.Id`	`jobId`	the `Id` for the job
	`osid.type.Type[]`	`availabilityRecordTypes`	array of availability record types
Return	`osid.resourcing.AvailabilityForm`		the availability form
Errors	NOT_FOUND		`resourceId` or `jobId` is not found
	NULL_ARGUMENT		`resourceId, jobId,` or `availabilityRecordTypes` 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	createAvailability
Description	Creates a new `Availability.`
Parameters	`osid.resourcing.AvailabilityForm`	`availabilityForm`	the form for this `Availability`
Return	`osid.resourcing.Availability`		the new `Availability`
Errors	ILLEGAL_STATE		`availabilityForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`availabilityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityForm` did not originate from `getAvailabilityFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAvailabilities
Description	Tests if this user can update `Availabilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Availability` 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 `Availability` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityFormForUpdate
Description	Gets the availability form for updating an existing availability. A new availability form should be requested for each update transaction.
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of the `Availability`
Return	`osid.resourcing.AvailabilityForm`		the availability form
Errors	NOT_FOUND		`availabilityId` is not found
	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAvailability
Description	Updates an existing availability.
Parameters	`osid.resourcing.AvailabilityForm`	`availabilityForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`availabilityForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`availabilityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityForm` did not originate from `getAvailabilityFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAvailabilities
Description	Tests if this user can delete `Availabilities.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Availability` 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 `Availability` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAvailability
Description	Deletes an `Availability.`
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of the `Availability` to remove
Errors	NOT_FOUND		`availabilityId` not found
	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAvailabilityAliases
Description	Tests if this user can manage `Id` aliases for `Availabilities.` 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 `Availability` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAvailability
Description	Adds an `Id` to an `Availability` for the purpose of creating compatibility. The primary `Id` of the `Availability` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another availability, it is reassigned to the given availability `Id.`
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of an `Availability`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`availabilityId` not found
	NULL_ARGUMENT		`availabilityId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.