OSID - osid.installation.PackageDepotSession Service Interface Definition

Interface	osid.installation.PackageDepotSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `Package` to `Depot` mappings. A `Package` may appear in multiple `Depots.` Each `Depot` may have its own authorizations governing who is allowed to look at it. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupPackageDepotMappings
Description	Tests if this user can perform lookups of package/depot mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDepotView
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	usePlenaryDepotView
Description	A complete view of the `Package` and `Depot` 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 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	useNormalizedDependencyView
Description	A normalized view uses a single `Package` to represent a set of package dependencies.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedDependencyView
Description	A denormalized view returns all dependencies.
Compliance	`mandatory`		This method is must be implemented.
Method	getPackageIdsByDepot
Description	Gets the list of `Package` `Ids` associated with a `Depot.`
Parameters	`osid.id.Id`	`depotId`	`Id` of the `Depot`
Return	`osid.id.IdList`		list of related package `Ids`
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByDepot
Description	Gets the list of `Packages` associated with a `Depot.`
Parameters	`osid.id.Id`	`depotId`	`Id` of the `Depot`
Return	`osid.installation.PackageList`		list of related packages
Errors	NOT_FOUND		`depotId` is not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackageIdsByDepots
Description	Gets the list of `Package Ids` corresponding to a list of `Depots.`
Parameters	`osid.id.IdList`	`depotIds`	list of depot `Ids`
Return	`osid.id.IdList`		list of package `Ids`
Errors	NULL_ARGUMENT		`depotIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPackagesByDepots
Description	Gets the list of `Packages` corresponding to a list of `Depots.`
Parameters	`osid.id.IdList`	`depotIds`	list of depot `Ids`
Return	`osid.installation.PackageList`		list of packages
Errors	NULL_ARGUMENT		`depotIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDepotIdsByPackage
Description	Gets the list of `Depot` `Ids` mapped to a `Package.`
Parameters	`osid.id.Id`	`packageId`	`Id` of a `Package`
Return	`osid.id.IdList`		list of depot `Ids`
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	getDepotsByPackage
Description	Gets the list of `Depots` mapped to a `Package.`
Parameters	`osid.id.Id`	`packageId`	`Id` of a `Package`
Return	`osid.installation.DepotList`		list of depots
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.