public interface QualifierQuerySession extends OsidSession
This session provides methods for searching among Qualifier
objects. The search query is constructed using the
QualifierQuery.
If more than one search element is specified
within a single QualifierQuery,
these elements form a
boolean AND.
This session defines views that offer differing behaviors for searching.
Qualifiers may have a query record indicated by their respective
record types. The query record is accessed via the QualifierQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchQualifiers()
Tests if this user can perform
Qualifier searches. |
QualifierQuery |
getQualifierQuery()
Gets a qualifier query.
|
QualifierList |
getQualifiersByQuery(QualifierQuery qualifierQuery)
Gets a list of
Qualifiers matching the given search. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
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 canSearchQualifiers()
Qualifier
searches. 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 search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. QualifierQuery getQualifierQuery()
mandatory
- This method must be implemented. QualifierList getQualifiersByQuery(QualifierQuery qualifierQuery) throws OperationFailedException, PermissionDeniedException
Qualifiers
matching the given search.qualifierQuery
- the search query array QualifierList
NullArgumentException
- qualifierQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- qualifierQuery
is
not of this servicemandatory
- This method must be implemented.