OSID - osid.installation.InstallationLookupSession Service Interface Definition

Interface	osid.installation.InstallationLookupSession
Implements	`osid.OsidSession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	The session defines methods for retrieving `Installations` from installation `Sites`. An `Installation` represents a `InstallationPackage` installed on a `Site`. Two views are defined in this session: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition normalized version view: multiple versions of the same package are suppressed denormalized version vew: all versions of an installation are returned Installations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Installation`.
Method	getSiteId
Description	Gets the `Site` `Id` associated with this session.
Return	`osid.id.Id`		the `Site Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSite
Description	Gets the `Site` associated with this session.
Return	`osid.installation.Site`		the `Site` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupInstallations
Description	Tests if this user can perform `Installation` 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	useComparativeInstallationView
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	usePlenaryInstallationView
Description	A complete view of the `Installation` 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	useNormalizedVersionView
Description	The returns from the lookup methods may omit multiple versions of the same installation.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedVersionView
Description	All versions of the same installation are returned.
Compliance	`mandatory`		This method is must be implemented.
Method	getInstallation
Description	Gets the `Installation` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Installation` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Installation` and retained for compatibility.
Parameters	`osid.id.Id`	`installationId`	`Id` of the `Installation`
Return	`osid.installation.Installation`		the installation
Errors	NOT_FOUND		`installationId` not found
	NULL_ARGUMENT		`installationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getInstallationsByIds
Description	Gets an `InstallationList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the installations 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 `Installations` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`installationIds`	the list of `Ids` to retrieve
Return	`osid.installation.InstallationList`		the returned `Installation` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`installationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsByGenusType
Description	Gets an `InstallationList` corresponding to the given installation genus `Type` which does not include installations of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known installations or an error results. Otherwise, the returned list may contain only those installations that are accessible through this session.
Parameters	`osid.type.Type`	`installationGenusType`	an installation genus type
Return	`osid.installation.InstallationList`		the returned `Installation` list
Errors	NULL_ARGUMENT		`installationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsByParentGenusType
Description	Gets an `InstallationList` corresponding to the given installation genus `Type` and include any additional installations with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known installations or an error results. Otherwise, the returned list may contain only those installations that are accessible through this session.
Parameters	`osid.type.Type`	`installationGenusType`	an installation genus type
Return	`osid.installation.InstallationList`		the returned `Installation` list
Errors	NULL_ARGUMENT		`installationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsByRecordType
Description	Gets an `InstallationList` containing the given installation record `Type`. In plenary mode, the returned list contains all known installations or an error results. Otherwise, the returned list may contain only those installations that are accessible through this session.
Parameters	`osid.type.Type`	`installationRecordType`	an installation record type
Return	`osid.installation.InstallationList`		the returned `Installation` list
Errors	NULL_ARGUMENT		`installationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsByInstallationPackage
Description	Gets an `InstallationList` corresponding to the given `InstallationPackage`. In plenary mode, the returned list contains all of the installations for the specified package, 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 `Installations` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.Id`	`installationPackageId`	`Id` of a `InstallationPackage`
Return	`osid.installation.InstallationList`		the returned `Installation` list
Errors	NULL_ARGUMENT		`installationPackageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallations
Description	Gets all `Installations`. In plenary mode, the returned list contains all known installations or an error results. Otherwise, the returned list may contain only those installations that are accessible through this session. In both cases, the order of the set is not specified.
Return	`osid.installation.InstallationList`		an `InstallationList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.