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

Interface	osid.room.squatting.DeedAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.room.squatting.batch.DeedBatchAdminSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session creates, updates, and deletes `Deeds`. 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 `Deed`, a `DeedForm` is requested using `getDeedFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `DeedForm` 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 `DeedForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `DeedForm` corresponds to an attempted transaction. For updates, `DeedForms` are requested to the `Deed` `Id` that is to be updated using `getDeedFormForUpdate()`. Similarly, the `DeedForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `DeedForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Deeds`. To unmap a `Deed` from the current `Campus`, the `DeedCampusAssignmentSession` should be used. These delete operations attempt to remove the `Deed` 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	canCreateDeeds
Description	Tests if this user can create `Deeds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Deed` 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 `Deed` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDeedWithRecordTypes
Description	Tests if this user can create a single `Deed` using the desired record interface types. While `RoomSquattingManager.getDeedRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Deed`. Providing an empty array tests if a `Deed` can be created with no records.
Parameters	`osid.type.Type[]`	`deedRecordTypes`	array of deed record types
Return	`boolean`		`true` if `Deed` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`deedRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDeedFormForCreate
Description	Gets the deed form for creating new deeds. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building
	`osid.id.Id`	`resourceId`	the `Id` of the owner resource
	`osid.type.Type[]`	`deedRecordTypes`	array of deed record types
Return	`osid.room.squatting.DeedForm`		the deed form
Errors	NOT_FOUND		`buildngId` or `resourceId` is not found
	NULL_ARGUMENT		`buildngId, resourceId`, or `deedRecordTypes` 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	createDeed
Description	Creates a new `Deed`.
Parameters	`osid.room.squatting.DeedForm`	`deedForm`	the form for this `Deed`
Return	`osid.room.squatting.Deed`		the new `Deed`
Errors	ILLEGAL_STATE		`deedForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`deedForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`deedForm` did not originate from `getDeedFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDeeds
Description	Tests if this user can update `Deeds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Deed` 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 `Deed` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDeedFormForUpdate
Description	Gets the deed form for updating an existing deed. A new deed form should be requested for each update transaction.
Parameters	`osid.id.Id`	`deedId`	the `Id` of the `Deed`
Return	`osid.room.squatting.DeedForm`		the deed form
Errors	NOT_FOUND		`deedId` is not found
	NULL_ARGUMENT		`deedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDeed
Description	Updates an existing deed.
Parameters	`osid.room.squatting.DeedForm`	`deedForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`deedForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`deedForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`deedForm` did not originate from `getDeedFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDeeds
Description	Tests if this user can delete `Deeds` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Deed` 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 `Deed` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDeed
Description	Deletes a `Deed`.
Parameters	`osid.id.Id`	`deedId`	the `Id` of the `Deed` to remove
Errors	NOT_FOUND		`deedId` not found
	NULL_ARGUMENT		`deedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDeedAliases
Description	Tests if this user can manage `Id` aliases for `Deeds`. 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 `Deed` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDeed
Description	Adds an `Id` to a `Deed` for the purpose of creating compatibility. The primary `Id` of the `Deed` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another deed, it is reassigned to the given deed `Id`.
Parameters	`osid.id.Id`	`deedId`	the `Id` of a `Deed`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`deedId` not found
	NULL_ARGUMENT		`deedId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.