OSID - osid.room.BuildingLookupSession Service Interface Definition

Interface	osid.room.BuildingLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Building` objects. The `Building` 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 room methods in this session operate, retrieve and pertain to buildings defined explicitly in the current campus. Using an isolated view is useful for managing buildings with the `BuildingAdminSession.` federated campus view: All building lookup methods in this session operate, retrieve and pertain to all buildings defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective building view: All building lookup methods return effective buildings. any effective building view: Buildings 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	canLookupBuildings
Description	Tests if this user can perform `Building` 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	useComparativeBuildingView
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	usePlenaryBuildingView
Description	A complete view of the `Building` 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 buildings 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	useEffectiveBuildingView
Description	Only buildings whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveBuildingView
Description	Buildings of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBuilding
Description	Gets the `Building` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Building` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Building` and retained for compatibility. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	`Id` of the `Building`
Return	`osid.room.Building`		the building
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 is must be implemented.
Method	getBuildingsByIds
Description	Gets a `BuildingList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the buildings 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 `Buildings` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`osid.id.IdList`	`buildingIds`	the list of `Ids` to retrieve
Return	`osid.room.BuildingList`		the returned `Building` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`buildingIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingsByGenusType
Description	Gets a `BuildingList` corresponding to the given building genus `Type` which does not include buildings of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`osid.type.Type`	`buildingGenusType`	a building genus type
Return	`osid.room.BuildingList`		the returned `Building` list
Errors	NULL_ARGUMENT		`buildingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingsByParentGenusType
Description	Gets a `BuildingList` corresponding to the given building genus `Type` and include any additional buildings with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`osid.type.Type`	`buildingGenusType`	a building genus type
Return	`osid.room.BuildingList`		the returned `Building` list
Errors	NULL_ARGUMENT		`buildingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingsByRecordType
Description	Gets a `BuildingList` containing the given building record `Type.` In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`osid.type.Type`	`buildingRecordType`	a building record type
Return	`osid.room.BuildingList`		the returned `Building` list
Errors	NULL_ARGUMENT		`buildingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingsOnDate
Description	Gets a list of all buildings effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings 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.BuildingList`		the returned `Building` list
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	getBuildingsByNumber
Description	Gets a `BuildingList` containing of the given building number. In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Parameters	`string`	`number`	a building number
Return	`osid.room.BuildingList`		the returned `Building` list
Errors	NULL_ARGUMENT		`number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBuildings
Description	Gets all `Buildings.` In plenary mode, the returned list contains all known buildings or an error results. Otherwise, the returned list may contain only those buildings that are accessible through this session. In effective mode, buildings are returned that are currently effective. In any effective mode, effective buildings and those currently expired are returned.
Return	`osid.room.BuildingList`		a list of `Buildings`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.