public interface ActivityObjectiveBankSession extends OsidSession
This session provides methods to retrieve Activity
to
ObjectiveBank
mappings. An Activity
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 |
canLookupActivityObjectiveBankMappings()
Tests if this user can perform lookups of activity/objective bank
mappings.
|
ActivityList |
getActivitiesByObjectiveBank(Id objectiveBankId)
Gets the list of
Activities associated with an
ObjectiveBank. |
ActivityList |
getActivitiesByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Activities corresponding to a list of
ObjectiveBanks. |
IdList |
getActivityIdsByObjectiveBank(Id objectiveBankId)
Gets the list of
Activity Ids associated
with an ObjectiveBank. |
IdList |
getActivityIdsByObjectiveBanks(IdList objectiveBankIds)
Gets the list of
Activity Ids corresponding to a list
of ObjectiveBanks. |
IdList |
getObjectiveBankIdsByActivity(Id activityId)
Gets the list of
ObjectiveBank Ids mapped to a
Activity. |
ObjectiveBankList |
getObjectiveBanksByActivity(Id activityId)
Gets the list of
ObjectiveBanks mapped to a
Activity. |
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
Activity and
ObjectiveBank returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActivityObjectiveBankMappings()
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()
Activity
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 getActivityIdsByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Activity
Ids
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. ActivityList getActivitiesByObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Activities
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. IdList getActivityIdsByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Activity 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. ActivityList getActivitiesByObjectiveBanks(IdList objectiveBankIds) throws OperationFailedException, PermissionDeniedException
Activities
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 getObjectiveBankIdsByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBank Ids
mapped to a
Activity.
activityId
- Id
of a Activity
Ids
NotFoundException
- activityId
is not
foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBanks
mapped to a
Activity.
activityId
- Id
of a Activity
Ids
NotFoundException
- activityId
is not
foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.