OSID - osid.room.FloorLookupSession Service Interface Definition

Interface	osid.room.FloorLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Floor` objects. The `Floor` represents a collection of rooms. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated campus view: All floor methods in this session operate, retrieve and pertain to floors defined explicitly in the current campus. Using an isolated view is useful for managing floors with the `FloorAdminSession.` federated campus view: All floor lookup methods in this session operate, retrieve and pertain to all floors defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective floor view: All floor lookup methods return effective floors. any effective floor view: Floors of any effective date are returned.
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	canLookupFloors
Description	Tests if this user can perform `Floor` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeFloorView
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	usePlenaryFloorView
Description	A complete view of the `Floor` 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 floors 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	useEffectiveFloorView
Description	Only floors whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveFloorView
Description	Floors of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getFloor
Description	Gets the `Floor` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Floor` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Floor` and retained for compatibility. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.id.Id`	`floorId`	`Id` of the `Floor`
Return	`osid.room.Floor`		the floor
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 is must be implemented.
Method	getFloorsByIds
Description	Gets a `FloorList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the floors 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 `Floors` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.id.IdList`	`floorIds`	the list of `Ids` to retrieve
Return	`osid.room.FloorList`		the returned `Floor` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`floorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsByGenusType
Description	Gets a `FloorList` corresponding to the given floor genus `Type` which does not include floors of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.type.Type`	`floorGenusType`	a floor genus type
Return	`osid.room.FloorList`		the returned `Floor` list
Errors	NULL_ARGUMENT		`floorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsByParentGenusType
Description	Gets a `FloorList` corresponding to the given floor genus `Type` and include any additional floors with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.type.Type`	`floorGenusType`	a floor genus type
Return	`osid.room.FloorList`		the returned `Floor` list
Errors	NULL_ARGUMENT		`floorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsByRecordType
Description	Gets a `FloorList` containing the given floor record `Type.` In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.type.Type`	`floorRecordType`	a floor record type
Return	`osid.room.FloorList`		the returned `Floor` list
Errors	NULL_ARGUMENT		`floorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsOnDate
Description	Gets a list of all floors effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors 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.FloorList`		the returned `FloorList`
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	getFloorsForBuilding
Description	Gets a list of all floors corresponding to a building `Id.` In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building
Return	`osid.room.FloorList`		the returned `FloorList`
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsForBuildingOnDate
Description	Gets a list of all floors 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 floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors 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.FloorList`		the returned `FloorList`
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	getFloorsByNumber
Description	Gets a list of all floors of the given number. In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Parameters	`string`	`number`	a floor number
Return	`osid.room.FloorList`		the returned `FloorList`
Errors	NULL_ARGUMENT		`number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFloors
Description	Gets all `Floors.` In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session. In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.
Return	`osid.room.FloorList`		a list of `Floors`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.