OSID - osid.room.construction.RenovationAdminSession Service Interface Definition

Interface	osid.room.construction.RenovationAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Renovations.` 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 `Renovation,` a `RenovationForm` is requested using `getRenovationFormForCreate()` specifying the desired peers and record `Types` or none if no record `Types` are needed. The returned `RenovationForm` 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 `RenovationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RenovationForm` corresponds to an attempted transaction. For updates, `RenovationForms` are requested to the `Renovation` `Id` that is to be updated using `getRenovationFormForUpdate().` Similarly, the `RenovationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RenovationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Renovations.` To unmap a `Renovation` from the current `Campus,` the `RenovationCampusAssignmentSession` should be used. These delete operations attempt to remove the `Renovation` 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	canCreateRenovations
Description	Tests if this user can create `Renovations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Renovation` 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 `Renovation` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRenovationWithRecordTypes
Description	Tests if this user can create a single `Renovation` using the desired record interface types. While `RoomConstructionManager.getRenovationRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Renovation.` Providing an empty array tests if a `Renovation` can be created with no records.
Parameters	`osid.type.Type[]`	`renovationRecordTypes`	array of renovation record types
Return	`boolean`		`true` if `Renovation` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`renovationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRenovationFormForCreate
Description	Gets the renovation form for creating new renovations. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`renovationRecordTypes`	array of renovation record types
Return	`osid.room.construction.RenovationForm`		the renovation form
Errors	NULL_ARGUMENT		`renovationRecordTypes` 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	createRenovation
Description	Creates a new `Renovation.`
Parameters	`osid.room.construction.RenovationForm`	`renovationForm`	the form for this `Renovation`
Return	`osid.room.construction.Renovation`		the new `Renovation`
Errors	ILLEGAL_STATE		`renovationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`renovationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`renovationForm` did not originate from `getRenovationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRenovations
Description	Tests if this user can update `Renovations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Renovation` 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 `Renovation` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRenovationFormForUpdate
Description	Gets the renovation form for updating an existing renovation. A new renovation form should be requested for each update transaction.
Parameters	`osid.id.Id`	`renovationId`	the `Id` of the `Renovation`
Return	`osid.room.construction.RenovationForm`		the renovation form
Errors	NOT_FOUND		`renovationId` is not found
	NULL_ARGUMENT		`renovationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRenovation
Description	Updates an existing renovation.
Parameters	`osid.room.construction.RenovationForm`	`renovationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`renovationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`renovationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`renovationForm` did not originate from `getRenovationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRenovations
Description	Tests if this user can delete `Renovations` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Renovation` 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 `Renovation` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRenovation
Description	Deletes a `Renovation.`
Parameters	`osid.id.Id`	`renovationId`	the `Id` of the `Renovation` to remove
Errors	NOT_FOUND		`renovationId` not found
	NULL_ARGUMENT		`renovationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRenovationAliases
Description	Tests if this user can manage `Id` aliases for `Renovations.` 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 `Renovation` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRenovation
Description	Adds an `Id` to a `Renovation` for the purpose of creating compatibility. The primary `Id` of the `Renovation` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another renovation, it is reassigned to the given renovation `Id.`
Parameters	`osid.id.Id`	`renovationId`	the `Id` of a `Renovation`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`renovationId` not found
	NULL_ARGUMENT		`renovationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.