OSID - osid.authorization.QualifierLookupSession Service Interface Definition

Interface	osid.authorization.QualifierLookupSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session defines methods for retrieving qualifiers. 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 qualifier methods in this session operate, retrieve and pertain to qualifiers defined explicitly in the current vault. Using an isolated view is useful for managing `Qualifiers` with the `QualifierAdminSession`. federated vault view: All qualifier methods in this session operate, retrieve and pertain to all qualifiers defined in this vault and any other qualifiers implicitly available in this vault through vault inheritence. The methods `useFederatedVaultView()` and `useIsolatedVaultView()` 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	canLookupQualifiers
Description	Tests if this user can perform `Qualifier` 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	useComparativeQualifierView
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	usePlenaryQualifierView
Description	A complete view of the `Qualifier` 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 qualifiers 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	getQualifier
Description	Gets the `Qualifier` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Qualifier` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Qualifier` and retained for compatibility.
Parameters	`osid.id.Id`	`qualifierId`	`Id` of the `Qualifier`
Return	`osid.authorization.Qualifier`		the qualifier
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getQualifiersByIds
Description	Gets a `QualifierList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the qualifiers 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 `Qualifiers` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`qualifierIds`	the list of `Ids` to retrieve
Return	`osid.authorization.QualifierList`		the returned `Qualifier` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`qualifierIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiersByGenusType
Description	Gets a `QualifierList` corresponding to the given qualifier genus `Type` which does not include qualifiers of types derived from the specified `Type`.In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session. In both cases, the order of the set is not specified.
Parameters	`osid.type.Type`	`qualifierGenusType`	a qualifier genus type
Return	`osid.authorization.QualifierList`		the returned `Qualifier` list
Errors	NULL_ARGUMENT		`qualifierGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiersByParentGenusType
Description	Gets a `QualifierList` corresponding to the given qualifier genus `Type` and include any additional qualifiers with genus types derived from the specified `Type`.In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session.
Parameters	`osid.type.Type`	`qualifierGenusType`	a qualifier genus type
Return	`osid.authorization.QualifierList`		the returned `Qualifier` list
Errors	NULL_ARGUMENT		`qualifierGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiersByRecordType
Description	Gets a `QualifierList` corresponding to the given qualifier record `Type`.The set of qualifiers implementing the given record type is returned. In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session.
Parameters	`osid.type.Type`	`qualifierRecordType`	a qualifier record type
Return	`osid.authorization.QualifierList`		the returned `Qualifier` list
Errors	NULL_ARGUMENT		`qualifierRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiers
Description	Gets all `Qualifiers`. In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session.
Return	`osid.authorization.QualifierList`		a list of `Qualifiers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.