public interface ActivityLookupSession extends OsidSession
This session provides methods for retrieving Activity
objects. The Activity
represents something to perform in
order to achieve a learning objective.
This session defines views that offer differing behaviors when retrieving multiple objects.
ActivityAdminSession.
Activities may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Activity.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupActivities()
Tests if this user can perform
Activity lookups. |
ActivityList |
getActivities()
Gets all
Activities. |
ActivityList |
getActivitiesByAsset(Id assetId)
Gets the activities for the given asset.
|
ActivityList |
getActivitiesByAssets(IdList assetIds)
Gets the activities for the given asset.
|
ActivityList |
getActivitiesByGenusType(Type activityGenusType)
Gets an
ActivityList corresponding to the given
activity genus Type which does not include activities
of genus types derived from the specified Type. |
ActivityList |
getActivitiesByIds(IdList activityIds)
Gets an
ActivityList corresponding to the given
IdList. |
ActivityList |
getActivitiesByParentGenusType(Type activityGenusType)
Gets an
ActivityList corresponding to the given
activity genus Type and include any additional activity
with genus types derived from the specified Type. |
ActivityList |
getActivitiesByRecordType(Type activityRecordType)
Gets a
ActivityList containing the given activity
record Type. |
ActivityList |
getActivitiesForObjective(Id objectiveId)
Gets the activities for the given objective.
|
ActivityList |
getActivitiesForObjectives(IdList objectiveIds)
Gets the activities for the given objectives.
|
Activity |
getActivity(Id activityId)
Gets the
Activity specified by its Id. |
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
void |
useComparativeActivityView()
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 |
useFederatedObjectiveBankView()
Federates the view for methods in this session.
|
void |
useIsolatedObjectiveBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryActivityView()
A complete view of the
Activity returns is desired. |
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 canLookupActivities()
Activity
lookups. 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 lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeActivityView()
mandatory
- This method is must be implemented. void usePlenaryActivityView()
Activity
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. void useFederatedObjectiveBankView()
mandatory
- This method is must be implemented. void useIsolatedObjectiveBankView()
mandatory
- This method is must be implemented. Activity getActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Activity
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Activity
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Activity
and retained for compatibility.activityId
- Id
of the Activity
NotFoundException
- activityId
not foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActivityList getActivitiesByIds(IdList activityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
activities specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Activities
may be omitted from the list
and may present the elements in any order including returning a unique
set.activityIds
- the list of Ids
to retrieve Activity
listNotFoundException
- an Id was
not foundNullArgumentException
- activityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitiesByGenusType(Type activityGenusType) throws OperationFailedException, PermissionDeniedException
ActivityList
corresponding to the given
activity genus Type
which does not include activities
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known activities or an
error results. Otherwise, the returned list may contain only those
activities that are accessible through this session.activityGenusType
- an activity genus type Activity
listNullArgumentException
- activityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitiesByParentGenusType(Type activityGenusType) throws OperationFailedException, PermissionDeniedException
ActivityList
corresponding to the given
activity genus Type
and include any additional activity
with genus types derived from the specified Type.
In
plenary mode, the returned list contains all known activities or an
error results. Otherwise, the returned list may contain only those
activities that are accessible through this session.activityGenusType
- an activity genus type Activity
listNullArgumentException
- activityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitiesByRecordType(Type activityRecordType) throws OperationFailedException, PermissionDeniedException
ActivityList
containing the given activity
record Type.
In plenary mode, the returned list
contains all known activities or an error results. Otherwise, the
returned list may contain only those activities that are accessible
through this session.activityRecordType
- an activity record type Activity
listNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitiesForObjective(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Id
or an error results if an Id in the supplied list is
not found or inaccessible. Otherwise, inaccessible Activities
may be omitted from the list and may present the elements in
any order including returning a unique set.objectiveId
- Id
of the Objective
NotFoundException
- objectiveId
not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActivityList getActivitiesForObjectives(IdList objectiveIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
Id
list, in the order of the list, including
duplicates, or an error results if a course offering Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Activities
may be omitted from the list
and may present the elements in any order including returning a unique
set.objectiveIds
- list of objective Ids
NotFoundException
- an objectiveId
not
foundNullArgumentException
- objectiveIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActivityList getActivitiesByAsset(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Id
or an error results if an Id
in the supplied
list is not found or inaccessible. Otherwise, inaccessible
Activities
may be omitted from the list and may present the
elements in any order including returning a unique set.assetId
- Id
of an Asset
NotFoundException
- assetId
not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActivityList getActivitiesByAssets(IdList assetIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
Id
or an error results if an Id
in the supplied
list is not found or inaccessible. Otherwise, inaccessible
Activities
may be omitted from the list and may present the
elements in any order including returning a unique set.assetIds
- Ids
of Assets
NotFoundException
- an assetId
not foundNullArgumentException
- assetIdList
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActivityList getActivities() throws OperationFailedException, PermissionDeniedException
Activities.
In plenary mode, the returned list
contains all known activites or an error results. Otherwise, the
returned list may contain only those activities that are accessible
through this session. ActivityList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.