OSID - osid.room.RoomLookupSession Service Interface Definition

Interface	osid.room.RoomLookupSession
Implements	`osid.OsidSession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session defines methods for retrieving rooms. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated campus view: All room methods in this session operate, retrieve and pertain to rooms defined explicitly in the current campus. Using an isolated view is useful for managing rooms with the `RoomAdminSession`. federated campus view: All room lookup methods in this session operate, retrieve and pertain to all rooms defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective room view: All room lookup methods return effective rooms. any effective room view: Rooms of any effective date are returned. The methods `useFederatedCampusView()` and `useIsolatedCampusView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupRooms
Description	Tests if this user can lookup rooms. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer these operations.
Return	`boolean`		`false` if room lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRoomView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryRoomView
Description	A complete view of the `Room` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCampusView
Description	Federates the view for methods in this session. A federated view will include rooms in campuses which are children of this campus in the campus hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveRoomView
Description	Only rooms whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveRoomView
Description	Rooms of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRoom
Description	Gets the `Room` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Room` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Room` and retained for compatibility. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the `Room` to retrieve
Return	`osid.room.Room`		the returned `Room`
Errors	NOT_FOUND		no `Room` found with the given `Id`
	NULL_ARGUMENT		`roomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByIds
Description	Gets a `RoomList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the rooms specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible rooms may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.IdList`	`roomIds`	the list of `Ids` to retrieve
Return	`osid.room.RoomList`		the returned `Room list`
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`roomIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusType
Description	Gets a `RoomList` corresponding to the given room genus `Type` which does not include rooms of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Return	`osid.room.RoomList`		the returned `Room` list
Errors	NULL_ARGUMENT		`roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByParentGenusType
Description	Gets a `RoomList` corresponding to the given room genus `Type` and include any additional rooms with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Return	`osid.room.RoomList`		the returned `Rooms` list
Errors	NULL_ARGUMENT		`roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByRecordType
Description	Gets a `RoomList` containing the given room record `Type`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.type.Type`	`roomRecordType`	a room record type
Return	`osid.room.RoomList`		the returned `Rooms` list
Errors	NULL_ARGUMENT		`roomRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsOnDate
Description	Gets a list of all rooms effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusTypeOnDate
Description	Gets a list of all rooms of a genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus `Type`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`roomGenusType, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsForBuilding
Description	Gets a list of all rooms corresponding to a building `Id`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsForBuildingOnDate
Description	Gets a list of all rooms corresponding to a building `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`buildingId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusTypeForBuilding
Description	Gets a list of all rooms of the given genus type corresponding to a building `Id`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	NULL_ARGUMENT		`buildingId` or `roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusTypeForBuildingOnDate
Description	Gets a list of all rooms of the given genus type corresponding to a building `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.type.Type`	`roomGenusType`	a room genus type
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`buildingId, roomGenusType, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsForFloor
Description	Gets a list of all rooms corresponding to a floor `Id`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`floorId`	the `Id` of the building
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	NULL_ARGUMENT		`floorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsForFloorOnDate
Description	Gets a list of all rooms corresponding to a floor `Id` and effective during the entire given date range inclusive but not confined to the date range. Rooms are returned with start effective dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`floorId`	a building `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`floorId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusTypeForFloor
Description	Gets a list of all rooms of the given genus type corresponding to a floor `Id`. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`floorId`	the `Id` of the floor
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	NULL_ARGUMENT		`floorId` or `roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByGenusTypeForFloorOnDate
Description	Gets a list of all rooms of the given genus type corresponding to a floor `Id` and effective during the entire given date range inclusive but not confined to the date range. Rooms are returned with start effective dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`osid.id.Id`	`floorId`	a floor `Id`
	`osid.type.Type`	`roomGenusType`	a room genus type
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`floorId, roomGenusType, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsByRoomNumber
Description	Gets a list of all rooms of the given room number. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Parameters	`string`	`number`	a room number
Return	`osid.room.RoomList`		the returned `RoomList`
Errors	NULL_ARGUMENT		`number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRooms
Description	Gets all rooms. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned.
Return	`osid.room.RoomList`		a list of rooms
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.