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

Interface	osid.authorization.rules.AuthorizationEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `AuthorizationEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated vault view: All authorization enabler methods in this session operate, retrieve and pertain to authorization enablers defined explicitly in the current vault. Using an isolated view is useful for managing `AuthorizationEnablers` with the `AuthorizationEnablerAdminSession.` federated vault view: All authorization enabler 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. active authorization enabler view: All authorization enabler lookup methods return active authorization enablers. any status authorization enabler view: Authorization enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupAuthorizationEnablers
Description	Tests if this user can perform `AuthorizationEnablers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAuthorizationEnablerView
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	usePlenaryAuthorizationEnablerView
Description	A complete view of the `AuthorizationEnabler` 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	useActiveAuthorizationEnablerView
Description	Only active authorization enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAuthorizationEnablerView
Description	All active and inactive authorization enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorizationEnabler
Description	Gets the `AuthorizationEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AuthorizationEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AuthorizationEnabler` and retained for compatibility. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.id.Id`	`authorizationEnablerId`	`Id` of the `AuthorizationEnabler`
Return	`osid.authorization.rules.AuthorizationEnabler`		the authorization enabler
Errors	NOT_FOUND		`authorizationEnablerId` not found
	NULL_ARGUMENT		`authorizationEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorizationEnablersByIds
Description	Gets an `AuthorizationEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the authorization enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `AuthorizationEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.id.IdList`	`authorizationEnablerIds`	the list of `Ids` to retrieve
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`authorizationEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersByGenusType
Description	Gets an `AuthorizationEnablerList` corresponding to the given authorization enabler genus `Type` which does not include authorization enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`authorizationEnablerGenusType`	an authorization enabler genus type
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	NULL_ARGUMENT		`authorizationEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersByParentGenusType
Description	Gets an `AuthorizationEnablerList` corresponding to the given authorization enabler genus `Type` and include any additional authorization enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`authorizationEnablerGenusType`	an authorization enabler genus type
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	NULL_ARGUMENT		`authorizationEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersByRecordType
Description	Gets an `AuthorizationEnablerList` containing the given authorization enabler record `Type.` In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`authorizationEnablerRecordType`	an authorization enabler record type
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	NULL_ARGUMENT		`authorizationEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersOnDate
Description	Gets an `AuthorizationEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersOnDateWithAgent
Description	Gets an `AuthorizationEnablerList` that are effective for the entire given date range and evaluated against the given agent. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active in addition to being effective in the given date range for the given agent. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablers
Description	Gets all `AuthorizationEnablers.` In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.