OSID - osid.authorization.AuthorizationSmartVaultSession Service Interface Definition

Interface	osid.authorization.AuthorizationSmartVaultSession
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. An `AuthorizationQuery` can be retrieved from this session and mapped to this `Vault` to create a virtual collection of `Authorizations`. The authorizations may be sequenced using the `AuthorizationSearchOrder` from this session. This `Vault` has a default query that matches any authorization and a default search order that specifies no sequencing. The queries may be examined using a `AuthorizationQueryInspector`. The query may be modified by converting the inspector back to a `AuthorizationQuery`.
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	canManageSmartVault
Description	Tests if this user can manage smart vault. 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	getAuthorizationQuery
Description	Gets an authorization query.
Return	`osid.authorization.AuthorizationQuery`		the authorization query
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationSearchOrder
Description	Gets an authorization search order.
Return	`osid.authorization.AuthorizationSearchOrder`		the authorization search order.
Compliance	`mandatory`		This method must be implemented.
Method	applyAuthorizationQuery
Description	Applies an authorization query to this vault.
Parameters	`osid.authorization.AuthorizationQuery`	`authorizationQuery`	the authorization query
Errors	NULL_ARGUMENT		`authorizationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`authorizationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuthorizationQuery
Description	Gets an authorization query inspector for this vault.
Return	`osid.authorization.AuthorizationQueryInspector`		the authorization query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuthorizationSequencing
Description	Applies an authorization search order to this vault.
Parameters	`osid.authorization.AuthorizationSearchOrder`	`authorizationSearchOrder`	the authorization search order
Errors	NULL_ARGUMENT		`authorizationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`authorizationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationQueryFromInspector
Description	Gets an authorization query from an inspector.
Parameters	`osid.authorization.AuthorizationQueryInspector`	`authorizationQueryInspector`	a resorce relationship query inspector
Return	`osid.authorization.AuthorizationQuery`		the authorization query
Errors	NULL_ARGUMENT		`authorizationQueryInspector` is `null`
Errors	UNSUPPORTED		`authorizationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.