public interface ObjectiveObjectiveBankSession extends OsidSession
This session provides methods to retrieve Objective
to
ObjectiveBank
mappings. An Objective
may
appear in multiple ObjectiveBanks.
Each
ObjectiveBank
may have its own authorizations governing who is
allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupObjectiveObjectiveBankMappings()
Tests if this user can perform lookups of objective/objective bank
mappings.
|
IdList |
getObjectiveBankIdsByObjective(Id objectiveId)
Gets the list of
ObjectiveBank Ids
mapped to an Objective. |
ObjectiveBankList |
getObjectiveBanksByObjective(Id objectiveId)
Gets the list of
ObjectiveBanks mapped to an
Objective. |
IdList |
getObjectiveIdsByObjectiveBank(Id objectiveBankId)
Gets the list of
Objective Ids
associated with an ObjectiveBank. |
IdList |
getObjectiveIdsByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Objective Ids corresponding to a list
of ObjectiveBanks. |
ObjectiveList |
getObjectivesByObjectiveBank(Id objectiveBankId)
Gets the list of
Objectives associated with an
ObjectiveBank. |
ObjectiveList |
getObjectivesByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Objectives corresponding to a list of
ObjectiveBanks. |
void |
useComparativeObjectiveBankView()
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 |
usePlenaryObjectiveBankView()
A complete view of the
Objective and
ObjectiveBank returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupObjectiveObjectiveBankMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeObjectiveBankView()
mandatory
- This method is must be implemented. void usePlenaryObjectiveBankView()
Objective
and
ObjectiveBank
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. IdList getObjectiveIdsByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
Ids
associated with an ObjectiveBank.
objectiveBankId
- Id
of the ObjectiveBank
NotFoundException
- objectiveBankId
is
not foundNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objectives
associated with an
ObjectiveBank.
objectiveBankId
- Id
of the ObjectiveBank
Ids
NotFoundException
- objectiveBankId
is
not foundNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getObjectiveIdsByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Objective Ids
corresponding to a list
of ObjectiveBanks.
objectiveBankIds
- list of objective bank Ids
Ids
NullArgumentException
- objectiveBankIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Objectives
corresponding to a list of
ObjectiveBanks.
objectiveBankIds
- list of objective bank Ids
NullArgumentException
- objectiveBankIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getObjectiveBankIdsByObjective(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBank
Ids
mapped to an Objective.
objectiveId
- Id
of an Objective
Ids
NotFoundException
- objectiveId
is not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByObjective(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBanks
mapped to an
Objective.
objectiveId
- Id
of an Objective
NotFoundException
- objectiveId
is not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.