OSID - osid.installation.PackageSmartDepotSession Service Interface Definition

Interface	osid.installation.PackageSmartDepotSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PackageQuery` can be retrieved from this session and mapped to this `Depot` to create a virtual collection of `Packages.` The packages may be sequenced using the `PackageSearchOrder` 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 `PackageQueryInspector.` The query may be modified by converting the inspector back to a `PackageQuery.`
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	getPackageQuery
Description	Gets a package query.
Return	`osid.installation.PackageQuery`		the package query
Compliance	`mandatory`		This method must be implemented.
Method	getPackageSearchOrder
Description	Gets a package search order.
Return	`osid.installation.PackageSearchOrder`		the package search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPackageQuery
Description	Applies a package query to this depot.
Parameters	`osid.installation.PackageQuery`	`packageQuery`	the package query
Errors	NULL_ARGUMENT		`packageQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`packageQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPackageQuery
Description	Gets a package query inspector for this depot.
Return	`osid.installation.PackageQueryInspector`		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	applyPackageSequencing
Description	Applies a package search order to this depot.
Parameters	`osid.installation.PackageSearchOrder`	`packageSearchOrder`	the package search order
Errors	NULL_ARGUMENT		`packageSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`packageSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPackageQueryFromInspector
Description	Gets a package query from an inspector.
Parameters	`osid.installation.PackageQueryInspector`	`packageQueryInspector`	a package query inspector
Return	`osid.installation.PackageQuery`		the package query
Errors	NULL_ARGUMENT		`packageQueryInspector` is `null`
Errors	UNSUPPORTED		`packageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.