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

Interface	osid.authorization.rules.AuthorizationEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `AuthorizationEnabler` to `Authorization` mappings. An `Authorization` with multiple `AuthorizationEnablers` means any positive rule evaluation across the enablers result in an effective `Authorization.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated vault view: All methods in this session operate, retrieve and pertain authorization enablers defined explicitly in the current vault federated vault view: All methods in this session operate, retrieve and pertain to all authorization enablers defined in this vault and any other authorization enablers implicitly available in this vault through vault inheritence.
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	canLookupAuthorizationEnablerRules
Description	Tests if this user can perform lookups of authorization enabler/authorization mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAuthorizationEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryAuthorizationEnablerRuleView
Description	A complete view of the `AuthorizationEnabler` and `Authorization` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedVaultView
Description	Federates the view for methods in this session. A federated view will include authorization enablers in vaults which are children of this vault in the vault hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedVaultView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorizationEnablerIdsForAuthorization
Description	Gets the `AuthorizationEnabler Id` associated with an `Authorization.`
Parameters	`osid.id.Id`	`authorizationId`	`Id` of the `Authorization`
Return	`osid.id.IdList`		the authorization enabler `Ids`
Errors	NOT_FOUND		`authorizationId` is not found
	NULL_ARGUMENT		`authorizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersForAuthorization
Description	Gets the `AuthorizationEnabler` associated with an `Authorization.`
Parameters	`osid.id.Id`	`authorizationId`	`Id` of the `Authorization`
Return	`osid.authorization.rules.AuthorizationEnablerList`		the authorization enablers
Errors	NOT_FOUND		`authorizationId` is not found
	NULL_ARGUMENT		`authorizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationIdsForAuthorizationEnabler
Description	Gets the `Authorization` `Ids` mapped to an `AuthorizationEnabler.`
Parameters	`osid.id.Id`	`authorizationEnablerId`	`Id` of an `AuthorizationEnabler`
Return	`osid.id.IdList`		list of authorization `Ids`
Errors	NOT_FOUND		`authorizationEnablerId` is not found
	NULL_ARGUMENT		`authorizationEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForAuthorizationEnabler
Description	Gets the `Authorizations` mapped to an `AuthorizationEnabler.`
Parameters	`osid.id.Id`	`authorizationEnablerId`	`Id` of an `AuthorizationEnabler`
Return	`osid.authorization.AuthorizationList`		list of authorizations
Errors	NOT_FOUND		`authorizationEnablerId` is not found
	NULL_ARGUMENT		`authorizationEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.