OSID - osid.installation.InstallationPackageSmartDepotSession Service Interface Definition

Interface	osid.installation.InstallationPackageSmartDepotSession
Implements	`osid.OsidSession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `InstallationPackageQuery` can be retrieved from this session and mapped to this `Depot` to create a virtual collection of `InstallationPackages`. The packages may be sequenced using the `InstallationPackageSearchOrder` from this session. This `Depot` has a default query that matches any package and a default search order that specifies no sequencing. The queries may be examined using a `InstallationPackageQueryInspector`. The query may be modified by converting the inspector back to a `InstallationPackageQuery`.
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	canManageSmartDepot
Description	Tests if this user can manage smart depot. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart depot management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageQuery
Description	Gets a package query.
Return	`osid.installation.InstallationPackageQuery`		the package query
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageSearchOrder
Description	Gets a package search order.
Return	`osid.installation.InstallationPackageSearchOrder`		the package search order
Compliance	`mandatory`		This method must be implemented.
Method	applyInstallationPackageQuery
Description	Applies a package query to this depot.
Parameters	`osid.installation.InstallationPackageQuery`	`installationPackageQuery`	the package query
Errors	NULL_ARGUMENT		`installationPackageQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`installationPackageQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectInstallationPackageQuery
Description	Gets a package query inspector for this depot.
Return	`osid.installation.InstallationPackageQueryInspector`		the package query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyInstallationPackageSequencing
Description	Applies a package search order to this depot.
Parameters	`osid.installation.InstallationPackageSearchOrder`	`installationPackageSearchOrder`	the package search order
Errors	NULL_ARGUMENT		`installationPackageSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`installationPackageSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageQueryFromInspector
Description	Gets a package query from an inspector.
Parameters	`osid.installation.InstallationPackageQueryInspector`	`installationPackageQueryInspector`	a package query inspector
Return	`osid.installation.InstallationPackageQuery`		the package query
Errors	NULL_ARGUMENT		`installationPackageQueryInspector` is `null`
Errors	UNSUPPORTED		`installationPackageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.