OSID - osid.installation.SiteLookupSession Service Interface Definition

Interface	osid.installation.SiteLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Site` objects. The `Site` represents a collection of `Installations.` 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 Sites may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Site.`
Method	canLookupSites
Description	Tests if this user can perform `Site` 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 opt not to 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	useComparativeSiteView
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	usePlenarySiteView
Description	A complete view of the `Site` 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	getSite
Description	Gets the `Site` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Site` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Site` and retained for compatibility.
Parameters	`osid.id.Id`	`siteId`	`Id` of the `Site`
Return	`osid.installation.Site`		the site
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getSites
Description	Gets all `Sites.` In plenary mode, the returned list contains all known sites or an error results. Otherwise, the returned list may contain only those sites that are accessible through this session.
Return	`osid.installation.SiteList`		a `SiteList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.