public interface ProficiencyObjectiveBankSession extends OsidSession
This session provides methods to retrieve Proficiency
to
ObjectiveBank
mappings. A Proficiency
may
appear in multiple ObjectiveBank
objects. Each objective
bank may have its own authorizations governing who is allowed to look at
it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProficiencyObjectiveBankMappings()
Tests if this user can perform lookups of proficiency/objective bank
mappings.
|
IdList |
getObjectiveBankIdsByProficiency(Id proficiencyId)
Gets the
ObjectiveBank Ids mapped to a
Proficiency. |
ObjectiveBankList |
getObjectiveBanksByProficiency(Id proficiencyId)
Gets the
ObjectiveBanks mapped to a Proficiency. |
ProficiencyList |
getProficienciesByObjectiveBank(Id objectiveBankId)
Gets the list of
Proficiencies associated with a
ObjectiveBank. |
ProficiencyList |
getProficienciesByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Proficiencies corresponding to a list
of ObjectiveBanks. |
IdList |
getProficiencyIdsByObjectiveBank(Id objectiveBankId)
Gets the list of
Proficiency Ids associated with a
ObjectiveBank. |
IdList |
getProficiencyIdsByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Proficiency Ids corresponding to a
list of ObjectiveBanks. |
void |
useComparativeProficiencyObjectiveBankView()
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 |
usePlenaryProficiencyObjectiveBankView()
A complete view of the
Proficiency and
ObjectiveBank returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupProficiencyObjectiveBankMappings()
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 useComparativeProficiencyObjectiveBankView()
mandatory
- This method is must be implemented. void usePlenaryProficiencyObjectiveBankView()
Proficiency
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 getProficiencyIdsByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Proficiency Ids
associated with a
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. ProficiencyList getProficienciesByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Proficiencies
associated with a
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. IdList getProficiencyIdsByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Proficiency Ids
corresponding to a
list of ObjectiveBanks.
objectiveBankIds
- list of objectiveBank Ids
Ids
NullArgumentException
- objectiveBankIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Proficiencies
corresponding to a list
of ObjectiveBanks.
objectiveBankIds
- list of objectiveBank Ids
NullArgumentException
- objectiveBankIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getObjectiveBankIdsByProficiency(Id proficiencyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBank
Ids
mapped to a
Proficiency.
proficiencyId
- Id
of a Proficiency
NotFoundException
- proficiencyId
is not
foundNullArgumentException
- proficiencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByProficiency(Id proficiencyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBanks
mapped to a Proficiency.
proficiencyId
- Id
of a Proficiency
NotFoundException
- proficiencyId
is not
foundNullArgumentException
- proficiencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.