public interface QualifierLookupSession extends OsidSession
This session defines methods for retrieving qualifiers.
This lookup session defines several views:
Qualifiers
with the QualifierAdminSession.
The methods useFederatedVaultView()
and
useIsolatedVaultView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQualifiers()
Tests if this user can perform
Qualifier lookups. |
Qualifier |
getQualifier(Id qualifierId)
Gets the
Qualifier specified by its Id. |
QualifierList |
getQualifiers()
Gets all
Qualifiers. |
QualifierList |
getQualifiersByGenusType(Type qualifierGenusType)
Gets a
QualifierList corresponding to the given
qualifier genus Type which does not include qualifiers
of types derived from the specified Type. |
QualifierList |
getQualifiersByIds(IdList qualifierIds)
Gets a
QualifierList corresponding to the given
IdList. |
QualifierList |
getQualifiersByParentGenusType(Type qualifierGenusType)
Gets a
QualifierList corresponding to the given
qualifier genus Type and include any additional
qualifiers with genus types derived from the specified Type. |
QualifierList |
getQualifiersByRecordType(Type qualifierRecordType)
Gets a
QualifierList corresponding to the given
qualifier record Type. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useComparativeQualifierView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
void |
usePlenaryQualifierView()
A complete view of the
Qualifier returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session. Vault
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupQualifiers()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeQualifierView()
mandatory
- This method is must be implemented. void usePlenaryQualifierView()
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.mandatory
- This method is must be implemented. void useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. Qualifier getQualifier(Id qualifierId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.qualifierId
- Id
of the Qualifier
NotFoundException
- qualifierId
not
foundNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. QualifierList getQualifiersByIds(IdList qualifierIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.qualifierIds
- the list of Ids
to retrieve Qualifier
listNotFoundException
- an Id was
not foundNullArgumentException
- qualifierIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QualifierList getQualifiersByGenusType(Type qualifierGenusType) throws OperationFailedException, PermissionDeniedException
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.qualifierGenusType
- a qualifier genus type Qualifier
listNullArgumentException
- qualifierGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QualifierList getQualifiersByParentGenusType(Type qualifierGenusType) throws OperationFailedException, PermissionDeniedException
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.qualifierGenusType
- a qualifier genus type Qualifier
listNullArgumentException
- qualifierGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QualifierList getQualifiersByRecordType(Type qualifierRecordType) throws OperationFailedException, PermissionDeniedException
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.qualifierRecordType
- a qualifier record type Qualifier
listNullArgumentException
- qualifierRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QualifierList getQualifiers() throws OperationFailedException, PermissionDeniedException
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. Qualifiers
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.