public interface ProficiencyQuerySession extends OsidSession
This session provides methods for searching among Proficiency
objects. The search query is constructed using the
ProficiencyQuery.
This session defines views that offer differing behaviors for searching.
Proficiencies may have a query record indicated by their respective
record types. The query record is accessed via the
ProficiencyQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchProficiencies()
Tests if this user can perform
Proficiency lookups. |
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
ProficiencyList |
getProficienciesByQuery(ProficiencyQuery proficiencyQuery)
Gets a list of
Proficiencies matching the given
proficiency query. |
ProficiencyQuery |
getProficiencyQuery()
Gets a proficiency query.
|
void |
useFederatedObjectiveBankView()
Federates the view for methods in this session.
|
void |
useIsolatedObjectiveBankView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveBankId()
ObjectiveBank
Id
associated
with this session. ObjectiveBank Id
associated with this
sessionmandatory
- This method must be implemented. ObjectiveBank getObjectiveBank() throws OperationFailedException, PermissionDeniedException
ObjectiveBank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchProficiencies()
Proficiency
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedObjectiveBankView()
mandatory
- This method is must be implemented. void useIsolatedObjectiveBankView()
mandatory
- This method is must be implemented. ProficiencyQuery getProficiencyQuery()
mandatory
- This method must be implemented. ProficiencyList getProficienciesByQuery(ProficiencyQuery proficiencyQuery) throws OperationFailedException, PermissionDeniedException
Proficiencies
matching the given
proficiency query.proficiencyQuery
- the proficiency query ProficiencyList
NullArgumentException
- proficiencyQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- proficiencyQuery
is not of this servicemandatory
- This method must be implemented.