OSID - osid.authorization.AuthorizationLookupSession Service Interface Definition

Interface	osid.authorization.AuthorizationLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods to search and retrieve `Authorization` mappings. This lookup session defines two sets of views: isolated vault view: All authorization methods in this session operate, retrieve and pertain to `Authorizations` defined explicitly in the current `Vault.` Using an isolated view is useful for managing `Authorizations` with the `AuthorizationAdminSession.` federated vault view; All authorization methods in this session operate, retrieve and pertain to all authorizations defined in this vault and any other authorizations implicitly available in this vault through vault inheritence. effective authorization view: All authorization lookup methods return edges where the current dates falls in between the effective dates inclusive. any effective authorization edge view: Authorizations of any effective date are returned. explicit authorization view: All authorization methods in this session operate, retrieve and pertain to only those authorizations that have been explicitly defined and not derived from `Resource` groups or `Qualifier` hierarchies. implicit authorization view; All authorization methods in this session operate, retrieve and pertain to all authorizations including those derived from `Resource` groups or `Qualifier` hierarchies. The methods `useExplicitAuthorizationView()` and `useImplicitAuthorizationView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupAuthorizations
Description	Tests if this user can perform authorization 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	useComparativeAuthorizationView
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	usePlenaryAuthorizationView
Description	A complete view of the `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 authorizations 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	useEffectiveAuthorizationView
Description	Only authorizations whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveAuthorizationView
Description	All authorizations of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useImplicitAuthorizationView
Description	Sets the view for methods in this session to implicit authorizations. An implicit view will include authorizations derived from other authorizations as a result of the `Qualifier,` `Function` or `Resource` hierarchies. This method is the opposite of `explicitAuthorizationView().`
Compliance	`mandatory`		This method is must be implemented.
Method	useExplicitAuthorizationView
Description	Sets the view for methods in this session to explicit authorizations. An explicit view includes only those authorizations that were explicitly defined and not implied. This method is the opposite of `implicitAuthorizationView().`
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorization
Description	Gets the `Authorization` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Authorization` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Authorization` and retained for compatibility.
Parameters	`osid.id.Id`	`authorizationId`	the `Id` of the `Authorization` to retrieve
Return	`osid.authorization.Authorization`		the returned `Authorization`
Errors	NOT_FOUND		no `Authorization` found with the given `Id`
	NULL_ARGUMENT		`authorizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByIds
Description	Gets an `AuthorizationList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the authorizations 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 `Authorizations` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`authorizationIds`	the list of `Ids` to retrieve
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`authorizationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByGenusType
Description	Gets an `AuthorizationList` corresponding to the given authorization genus `Type` which does not include authorizations of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.type.Type`	`authorizationGenusType`	an authorization genus type
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	NULL_ARGUMENT		`authorizationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByParentGenusType
Description	Gets an `AuthorizationList` corresponding to the given authorization genus `Type` and include authorizations of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.type.Type`	`authorizationGenusType`	an authorization genus type
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	NULL_ARGUMENT		`authorizationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByRecordType
Description	Gets an `AuthorizationList` containing the given authorization record `Type.` In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.type.Type`	`authorizationRecordType`	an authorization record type
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	NULL_ARGUMENT		`authorizationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsOnDate
Description	Gets an `AuthorizationList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForResource
Description	Gets a list of `Authorizations` associated with a given resource. Authorizations related to the given resource, including those related through an `Agent,` are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForResourceOnDate
Description	Gets an `AuthorizationList` effective during the entire given date range inclusive but not confined to the date range. Authorizations related to the given resource, including those related through an `Agent,` are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForAgent
Description	Gets a list of `Authorizations` associated with a given agent. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForAgentOnDate
Description	Gets an `AuthorizationList` for the given agent and effective during the entire given date range inclusive but not confined to the date range In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForFunction
Description	Gets a list of `Authorizations` associated with a given function. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`functionId`	a function `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForFunctionOnDate
Description	Gets an `AuthorizationList` for the given function and effective during the entire given date range inclusive but not confined to the date range In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.id.Id`	`functionId`	a function `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`functionId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForResourceAndFunction
Description	Gets a list of `Authorizations` associated with a given resource. Authorizations related to the given resource, including those related through an `Agent,` are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`functionId`	a function `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`resourceId` or `functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForResourceAndFunctionOnDate
Description	Gets an `AuthorizationList` effective during the entire given date range inclusive but not confined to the date range. Authorizations related to the given resource, including those related through an `Agent,` are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`functionId`	a function `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, functionId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForAgentAndFunction
Description	Gets a list of `Authorizations` associated with a given agent. Authorizations related to the given resource, including those related through an `Agent,` are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`osid.id.Id`	`functionId`	a function `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`agentId` or `functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsForAgentAndFunctionOnDate
Description	Gets an `AuthorizationList` for the given agent and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.id.Id`	`functionId`	a function `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.authorization.AuthorizationList`		the returned `Authorization` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, functionId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByQualifier
Description	Gets a list of `Authorizations` associated with a given qualifier. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Return	`osid.authorization.AuthorizationList`		the returned `Authorization list`
Errors	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getExplicitAuthorization
Description	Gets the explicit `Authorization` that generated the given implicit authorization. If the given `Authorization` is explicit, then the same `Authorization` is returned.
Parameters	`osid.id.Id`	`authorizationId`	an authorization
Return	`osid.authorization.Authorization`		the explicit `Authorization`
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	getAuthorizations
Description	Geta all `Authorizations.` In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session.
Return	`osid.authorization.AuthorizationList`		a list of `Authorizations`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.