OSID - osid.room.RoomAdminSession Service Interface Definition

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