OSID - osid.authorization.FunctionSmartVaultSession Service Interface Definition

Interface	osid.authorization.FunctionSmartVaultSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `FunctionQuery` can be retrieved from this session and mapped to this `Vault` to create a virtual collection of `Functions`. The functions may be sequenced using the `FunctionSearchOrder` from this session. This `Vault` has a default query that matches any function and a default search order that specifies no sequencing. The queries may be examined using a `FunctionQueryInspector`. The query may be modified by converting the inspector back to a `FunctionQuery`.
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the `Vault` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartVaults
Description	Tests if this user can manage smart vaults. 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 vault management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionQuery
Description	Gets a function query.
Return	`osid.authorization.FunctionQuery`		the function query
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionSearchOrder
Description	Gets a function search order.
Return	`osid.authorization.FunctionSearchOrder`		the function search order
Compliance	`mandatory`		This method must be implemented.
Method	applyFunctionQuery
Description	Applies a function query to this vault.
Parameters	`osid.authorization.FunctionQuery`	`functionQuery`	the function query
Errors	NULL_ARGUMENT		`functionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`functionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectFunctionQuery
Description	Gets a function query inspector for this vault.
Return	`osid.authorization.FunctionQueryInspector`		the function query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyFunctionSequencing
Description	Applies a function search order to this vault.
Parameters	`osid.authorization.FunctionSearchOrder`	`functionSearchOrder`	the function search order
Errors	NULL_ARGUMENT		`functionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`functionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionQueryFromInspector
Description	Gets a function query from an inspector.
Parameters	`osid.authorization.FunctionQueryInspector`	`functionQueryInspector`	a function query inspector
Return	`osid.authorization.FunctionQuery`		the function query
Errors	NULL_ARGUMENT		`functionQueryInspector` is `null`
Errors	UNSUPPORTED		`functionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.