public interface ObjectiveSmartObjectiveBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ObjectiveQuery
can be retrieved from this
session and mapped to this ObjectiveBank
to create a
virtual collection of Objectives.
The objectives may be
sequenced using the ObjectiveSearchOrder
from this session.
This ObjectiveBank
has a default query that matches any
objective and a default search order that specifies no sequencing. The
queries may be examined using an ObjectiveQueryInspector.
The query may be modified by converting the inspector back to an
ObjectiveQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyObjectiveQuery(ObjectiveQuery objectiveQuery)
Applies an objective query to this bank.
|
void |
applyObjectiveSequencing(ObjectiveSearchOrder objectiveSearchOrder)
Applies an objective search order to this objective bank.
|
boolean |
canManageSmartObjectiveBanks()
Tests if this user can manage smart objective banks.
|
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.
|
ObjectiveQuery |
getObjectiveQueryFromInspector(ObjectiveQueryInspector objectiveQueryInspector)
Gets an objective query from an inspector.
|
ObjectiveSearchOrder |
getObjectiveSearchOrder()
Gets an objective search order.
|
ObjectiveQueryInspector |
inspectObjectiveQuery()
Gets an objective query inspector for this objective bank.
|
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 canManageSmartObjectiveBanks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart objective bank management is not
authorized, true
otherwisemandatory
- This method must be implemented. ObjectiveQuery getObjectiveQuery()
mandatory
- This method must be implemented. ObjectiveSearchOrder getObjectiveSearchOrder()
mandatory
- This method must be implemented. void applyObjectiveQuery(ObjectiveQuery objectiveQuery) throws OperationFailedException, PermissionDeniedException
objectiveQuery
- the objective queryNullArgumentException
- objectiveQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- objectiveQuery
not of this servicemandatory
- This method must be implemented. ObjectiveQueryInspector inspectObjectiveQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyObjectiveSequencing(ObjectiveSearchOrder objectiveSearchOrder) throws OperationFailedException, PermissionDeniedException
objectiveSearchOrder
- the objective search orderNullArgumentException
- objectiveSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- objectiveSearchOrder
not of this servicemandatory
- This method must be implemented. ObjectiveQuery getObjectiveQueryFromInspector(ObjectiveQueryInspector objectiveQueryInspector)
objectiveQueryInspector
- a query inspectorNullArgumentException
- objectiveQueryInspector
is null
UnsupportedException
- objectiveQueryInspector
is not of this servicemandatory
- This method must be implemented.