OSID - osid.room.BuildingAdminSession Service Interface Definition

Interface	osid.room.BuildingAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.room.batch.BuildingBatchAdminSession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session creates, updates, and deletes `Buildings`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Building`, a `BuildingForm` is requested using `getBuildingFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BuildingForm` 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 `BuildingForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BuildingForm` corresponds to an attempted transaction. For updates, `BuildingForms` are requested to the `Building` `Id` that is to be updated using `getBuildingFormForUpdate()`. Similarly, the `BuildingForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BuildingForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Buildings`. To unmap a `Building` from the current `Campus`, the `BuildingCampusAssignmentSession` should be used. These delete operations attempt to remove the `Building` 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	canCreateBuildings
Description	Tests if this user can create `Buildings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Building` 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 `Building` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBuildingWithRecordTypes
Description	Tests if this user can create a single `Building` using the desired record interface types. While `RoomManager.getBuildingRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Building`. Providing an empty array tests if a `Building` can be created with no records.
Parameters	`osid.type.Type[]`	`buildingRecordTypes`	array of building record types
Return	`boolean`		`true` if `Building` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`buildingRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingFormForCreate
Description	Gets the building form for creating new buildings. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`buildingRecordTypes`	array of building record types
Return	`osid.room.BuildingForm`		the building form
Errors	NULL_ARGUMENT		`buildingRecordTypes` 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	createBuilding
Description	Creates a new `Building`.
Parameters	`osid.room.BuildingForm`	`buildingForm`	the form for this `Building`
Return	`osid.room.Building`		the new `Building`
Errors	ILLEGAL_STATE		`buildingForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`buildingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`buildingForm` did not originate from `getBuildingFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBuildings
Description	Tests if this user can update `Buildings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Building` 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 `Building` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingFormForUpdate
Description	Gets the building form for updating an existing building. A new building form should be requested for each update transaction.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the `Building`
Return	`osid.room.BuildingForm`		the building form
Errors	NOT_FOUND		`buildingId` is not found
	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBuilding
Description	Updates an existing building.
Parameters	`osid.room.BuildingForm`	`buildingForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`buildingForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`buildingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`buildingForm` did not originate from `getBuildingFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBuildings
Description	Tests if this user can delete `Buildings` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Building` 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 `Building` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBuilding
Description	Deletes a `Building`.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the `Building` to remove
Errors	NOT_FOUND		`buildingId` not found
	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBuildingAliases
Description	Tests if this user can manage `Id` aliases for `Buildings`. 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 `Building` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBuilding
Description	Adds an `Id` to a `Building` for the purpose of creating compatibility. The primary `Id` of the `Building` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another building, it is reassigned to the given building `Id`.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of a `Building`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`buildingId` not found
	NULL_ARGUMENT		`buildingId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.