OSID - osid.room.squatting.LeaseAdminSession Service Interface Definition

Interface	osid.room.squatting.LeaseAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.room.squatting.batch.LeaseBatchAdminSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session creates, updates, and deletes `Leases`. 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 `Lease`, a `LeaseForm` is requested using `getLeaseFormForCreate()` specifying the desired peers and record `Types` or none if no record `Types` are needed. The returned `LeaseForm` 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 `LeaseForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `LeaseForm` corresponds to an attempted transaction. For updates, `LeaseForms` are requested to the `Lease` `Id` that is to be updated using `getLeaseFormForUpdate()`. Similarly, the `LeaseForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `LeaseForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Leases`. To unmap a `Lease` from the current `Campus`, the `LeaseCampusAssignmentSession` should be used. These delete operations attempt to remove the `Lease` itself thus removing it from all known `Campus` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLeases
Description	Tests if this user can create `Leases`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Lease` 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 `Lease` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLeaseWithRecordTypes
Description	Tests if this user can create a single `Lease` using the desired record interface types. While `RoomSquattingManager.getLeaseRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Lease`. Providing an empty array tests if a `Lease` can be created with no records.
Parameters	`osid.type.Type[]`	`leaseRecordTypes`	array of lease record types
Return	`boolean`		`true` if `Lease` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`leaseRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseFormForCreate
Description	Gets the lease form for creating new leases. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`osid.id.Id`	`resourceId`	a tenant resource `Id`
	`osid.type.Type[]`	`leaseRecordTypes`	array of lease record types
Return	`osid.room.squatting.LeaseForm`		the lease form
Errors	NOT_FOUND		`roomId or resourceId` is not found
	NULL_ARGUMENT		`roomId, resourceId`, or `leaseRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get from for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createLease
Description	Creates a new `Lease`.
Parameters	`osid.room.squatting.LeaseForm`	`leaseForm`	the form for this `Lease`
Return	`osid.room.squatting.Lease`		the new `Lease`
Errors	ILLEGAL_STATE		`leaseForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`leaseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`leaseForm` did not originate from `getLeaseFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateLeases
Description	Tests if this user can update `Leases`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Lease` 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 `Lease` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseFormForUpdate
Description	Gets the lease form for updating an existing lease. A new lease form should be requested for each update transaction.
Parameters	`osid.id.Id`	`leaseId`	the `Id` of the `Lease`
Return	`osid.room.squatting.LeaseForm`		the lease form
Errors	NOT_FOUND		`leaseId` is not found
	NULL_ARGUMENT		`leaseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateLease
Description	Updates an existing lease.
Parameters	`osid.room.squatting.LeaseForm`	`leaseForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`leaseForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`leaseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`leaseForm` did not originate from `getLeaseFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteLeases
Description	Tests if this user can delete `Leases` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Lease` 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 `Lease` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteLease
Description	Deletes a `Lease`.
Parameters	`osid.id.Id`	`leaseId`	the `Id` of the `Lease` to remove
Errors	NOT_FOUND		`leaseId` not found
	NULL_ARGUMENT		`leaseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageLeaseAliases
Description	Tests if this user can manage `Id` aliases for `Leases`. 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 `Lease` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasLease
Description	Adds an `Id` to a `Lease` for the purpose of creating compatibility. The primary `Id` of the `Lease` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another lease, it is reassigned to the given lease `Id`.
Parameters	`osid.id.Id`	`leaseId`	the `Id` of a `Lease`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`leaseId` not found
	NULL_ARGUMENT		`leaseId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.