OSID - osid.room.FloorAdminSession Service Interface Definition

Interface	osid.room.FloorAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Floors.` 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 `Floor,` a `FloorForm` is requested using `getFloorFormForCreate()` specifying the desired building and record `Types` or none if no record `Types` are needed. The returned `FloorForm` 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 `FloorForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `FloorForm` corresponds to an attempted transaction. For updates, `FloorForms` are requested to the `Floor` `Id` that is to be updated using `getFloorFormForUpdate().` Similarly, the `FloorForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `FloorForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Floors.` To unmap a `Floor` from the current `Campus,` the `FloorCampusAssignmentSession` should be used. These delete operations attempt to remove the `Floor` 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	canCreateFloors
Description	Tests if this user can create `Floors.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Floor` 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 `Floor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFloorWithRecordTypes
Description	Tests if this user can create a single `Floor` using the desired record interface types. While `RoomManager.getFloorRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Floor.` Providing an empty array tests if a `Floor` can be created with no records.
Parameters	`osid.type.Type[]`	`floorRecordTypes`	array of floor record types
Return	`boolean`		`true` if `Floor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`floorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFloorFormForCreate
Description	Gets the floor form for creating new floors. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`osid.type.Type[]`	`floorRecordTypes`	array of floor record types
Return	`osid.room.FloorForm`		the floor form
Errors	NOT_FOUND		`buildingId` is not found
	NULL_ARGUMENT		`buildingId` or `floorRecordTypes` 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	createFloor
Description	Creates a new `Floor.`
Parameters	`osid.room.FloorForm`	`floorForm`	the form for this `Floor`
Return	`osid.room.Floor`		the new `Floor`
Errors	ILLEGAL_STATE		`floorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`floorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`floorForm` did not originate from `getFloorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateFloors
Description	Tests if this user can update `Floors.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Floor` 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 `Floor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFloorFormForUpdate
Description	Gets the floor form for updating an existing floor. A new floor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`floorId`	the `Id` of the `Floor`
Return	`osid.room.FloorForm`		the floor form
Errors	NOT_FOUND		`floorId` is not found
	NULL_ARGUMENT		`floorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateFloor
Description	Updates an existing floor.
Parameters	`osid.room.FloorForm`	`floorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`floorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`floorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`floorForm` did not originate from `getFloorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteFloors
Description	Tests if this user can delete `Floors` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Floor` 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 `Floor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFloor
Description	Deletes a `Floor.`
Parameters	`osid.id.Id`	`floorId`	the `Id` of the `Floor` to remove
Errors	NOT_FOUND		`floorId` not found
	NULL_ARGUMENT		`floorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageFloorAliases
Description	Tests if this user can manage `Id` aliases for `Floors.` 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 `Floor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFloor
Description	Adds an `Id` to a `Floor` for the purpose of creating compatibility. The primary `Id` of the `Floor` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another floor, it is reassigned to the given floor `Id.`
Parameters	`osid.id.Id`	`floorId`	the `Id` of a `Floor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`floorId` not found
	NULL_ARGUMENT		`floorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.