OSID - osid.installation.PackageLookupSession Service Interface Definition

Interface	osid.installation.PackageLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Package` s from remote `Depots.` 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 depot view: All package methods in this session operate, retrieve and pertain to packages defined explicitly in the current depot. Using an isolated view is useful for managing packages with the `PackageAdminSession.` federated depot view: All package methods in this session operate, retrieve and pertain to all packages defined in this depot and any other depots implicitly available in this depot through depot inheritence. normalized version view: multiple versions of the same package are suppressed denormalized version vew: all versions of an installation are returned Packages may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Package.`
Method	getDepotId
Description	Gets the `Depot` `Id` associated with this session.
Return	`osid.id.Id`		the `Depot Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDepot
Description	Gets the `Depot` associated with this session.
Return	`osid.installation.Depot`		the `Depot` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPackages
Description	Tests if this user can perform `Package` 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	useComparativePackageView
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	usePlenaryPackageView
Description	A complete view of the `Package` 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	useFederatedDepotView
Description	Federates the view for methods in this session. A federated view will include packages in depots which are children of this depot in the depot hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDepotView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this depot only.
Compliance	`mandatory`		This method is must be implemented.
Method	useNormalizedVersionView
Description	The returns from the lookup methods may omit multiple versions of the same package.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedVersionView
Description	All versions of the same package are returned.
Compliance	`mandatory`		This method is must be implemented.
Method	getPackage
Description	Gets the `Package` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Package` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Package` and retained for compatibility.
Parameters	`osid.id.Id`	`packageId`	`Id` of the `Package`
Return	`osid.installation.Package`		the package
Errors	NOT_FOUND		`packageId` not found
	NULL_ARGUMENT		`packageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPackagesByIds
Description	Gets a `PackageList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the packages 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 `Packages` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`packageIds`	the list of `Ids` to retrieve
Return	`osid.installation.PackageList`		the returned `Package` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`packageIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByGenusType
Description	Gets a `PackageList` corresponding to the given package genus `Type` which does not include packages of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.
Parameters	`osid.type.Type`	`packageGenusType`	a package genus type
Return	`osid.installation.PackageList`		the returned `Package` list
Errors	NULL_ARGUMENT		`packageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByParentGenusType
Description	Gets a `PackageList` corresponding to the given package genus `Type` and include any additional package with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.
Parameters	`osid.type.Type`	`packageGenusType`	a package genus type
Return	`osid.installation.PackageList`		the returned `Package` list
Errors	NULL_ARGUMENT		`packageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByRecordType
Description	Gets a `PackageList` containing the given package record `Type.` In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.
Parameters	`osid.type.Type`	`packageRecordType`	a package record type
Return	`osid.installation.PackageList`		the returned `Package` list
Errors	NULL_ARGUMENT		`packageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByProvider
Description	Gets a `PackageList` for the given provider. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.installation.PackageList`		the returned `Package` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDependentPackages
Description	Gets a list of packages depending on the given package.
Parameters	`osid.id.Id`	`packageId`	an `Id` of a `Package`
Return	`osid.installation.PackageList`		list of package dependents
Errors	NOT_FOUND		`packageId` is not found
	NULL_ARGUMENT		`packageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackageVersions
Description	Gets a list of packages in the specified package version chain.
Parameters	`osid.id.Id`	`packageId`	an `Id` of a `Package`
Return	`osid.installation.PackageList`		list of dependencies
Errors	NOT_FOUND		`packageId` is not found
	NULL_ARGUMENT		`packageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackages
Description	Gets all `Packages.` In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.
Return	`osid.installation.PackageList`		a `PackageList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.