public interface ObjectiveQuerySession extends OsidSession
This session provides methods for searching Objective
objects. The search query is constructed using the ObjectiveQuery.
The objective record Type
also specifies the record
for the objective query.
This session defines views that offer differing behaviors for searching.
Objectives may have a query record indicated by their respective
record types. The query record is accessed via the ObjectiveQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchObjectives()
Tests if this user can perform
Objectives searches. |
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
ObjectiveQuery |
getObjectiveQuery()
Gets an objective query.
|
ObjectiveList |
getObjectivesByQuery(ObjectiveQuery objectiveQuery)
Gets a list of
Objectives matching the given objective
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. ObjectiveBank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchObjectives()
Objectives
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 useFederatedObjectiveBankView()
mandatory
- This method is must be implemented. void useIsolatedObjectiveBankView()
mandatory
- This method is must be implemented. ObjectiveQuery getObjectiveQuery()
mandatory
- This method must be implemented. ObjectiveList getObjectivesByQuery(ObjectiveQuery objectiveQuery) throws OperationFailedException, PermissionDeniedException
Objectives
matching the given objective
query.objectiveQuery
- the objective query ObjectiveList
NullArgumentException
- objectiveQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- objectiveQuery
is
not of this servicemandatory
- This method must be implemented.