OSID - osid.authorization.rules.AuthorizationEnablerSmartVaultSession Service Interface Definition

Interface	osid.authorization.rules.AuthorizationEnablerSmartVaultSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.rules.AuthorizationRulesManager`
Used By	`osid.authorization.rules.AuthorizationRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic vaults. An `AuthorizationEnablerQuery` can be retrieved from this session and mapped to this `Vault` to create a virtual collection of authorization enablers. The authorization enablers may be sequenced using the `AuthorizationEnablerSearchOrder` from this session. This `Vault` has a default query that matches any authorization enabler and a default search order that specifies no sequencing. The queries may be examined using an `AuthorizationEnablerQueryInspector`. The query may be modified by converting the inspector back to an `AuthorizationEnablerQuery`.
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
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	getAuthorizationEnablerQuery
Description	Gets an authorization enabler query.
Return	`osid.authorization.rules.AuthorizationEnablerQuery`		the authorization enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablerSearchOrder
Description	Gets an authorization enabler search order.
Return	`osid.authorization.rules.AuthorizationEnablerSearchOrder`		the authorization enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuthorizationEnablerQuery
Description	Applies an authorization enabler query to this vault.
Parameters	`osid.authorization.rules.AuthorizationEnablerQuery`	`authorizationEnablerQuery`	the authorization enabler query
Errors	NULL_ARGUMENT		`authorizationEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`authorizationEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuthorizationEnablerQuery
Description	Gets an authorization enabler query inspector for this vault.
Return	`osid.authorization.rules.AuthorizationEnablerQueryInspector`		the authorization enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuthorizationEnablerSequencing
Description	Applies an authorization enabler search order to this vault.
Parameters	`osid.authorization.rules.AuthorizationEnablerSearchOrder`	`authorizationEnablerSearchOrder`	the authorization enabler search order
Errors	NULL_ARGUMENT		`authorizationEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`authorizationEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablerQueryFromInspector
Description	Gets an authorization enabler query from an inspector.
Parameters	`osid.authorization.rules.AuthorizationEnablerQueryInspector`	`authorizationEnablerQueryInspector`	an authorization enabler query inspector
Return	`osid.authorization.rules.AuthorizationEnablerQuery`		the authorization enabler query
Errors	NULL_ARGUMENT		`authorizationEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`authorizationEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.