public interface ActivityUnitLookupSession extends OsidSession
This session defines methods for retrieving activity units. An
ActivityUnit
is derived from a Course
and maps to
an offering time and registered students.
This lookup session defines several views:
ActivityUnits
with the
ActivityUnitAdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Activity units may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the ActivityUnit.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupActivityUnits()
Tests if this user can perform
ActivityUnit lookups. |
ActivityUnit |
getActivityUnit(Id activityUnitId)
Gets the
ActivityUnit specified by its Id. |
ActivityUnitList |
getActivityUnits()
Gets all
ActivityUnits. |
ActivityUnitList |
getActivityUnitsByGenusType(Type activityUnitGenusType)
Gets an
ActivityUnitList corresponding to the given
activity unit genus Type which does not include
activity units of types derived from the specified Type
. |
ActivityUnitList |
getActivityUnitsByIds(IdList activityUnitIds)
Gets an
ActivityUnitList corresponding to the given
IdList. |
ActivityUnitList |
getActivityUnitsByParentGenusType(Type activityUnitGenusType)
Gets an
ActivityUnitList corresponding to the given
activity unit genus Type and include any additional
activity units with genus types derived from the specified
Type. |
ActivityUnitList |
getActivityUnitsByRecordType(Type activityUnitRecordType)
Gets an
ActivityUnitList containing the given activity
unit record Type. |
ActivityUnitList |
getActivityUnitsForCourse(Id courseId)
Gets an
ActivityUnitList for the given course. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
useActiveActivityUnitView()
Only active activity units are returned by methods in this session.
|
void |
useAnyStatusActivityUnitView()
All activity units of any active or inactive status are returned by
methods in this session.
|
void |
useComparativeActivityUnitView()
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 |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryActivityUnitView()
A complete view of the
ActivityUnit returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupActivityUnits()
ActivityUnit
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeActivityUnitView()
mandatory
- This method is must be implemented. void usePlenaryActivityUnitView()
ActivityUnit
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 useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useActiveActivityUnitView()
mandatory
- This method is must be implemented. void useAnyStatusActivityUnitView()
mandatory
- This method is must be implemented. ActivityUnit getActivityUnit(Id activityUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityUnit
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ActivityUnit
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ActivityUnit
and retained for
compatibility.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.activityUnitId
- the Id
of the
ActivityUnit
to retrieve ActivityUnit
NotFoundException
- no ActivityUnit
found with the given Id
NullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnitsByIds(IdList activityUnitIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityUnitList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
activity units 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 ActivityUnits
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.activityUnitIds
- the list of Ids
to retrieve ActivityUnit
listNotFoundException
- an Id was
not foundNullArgumentException
- activityUnitIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnitsByGenusType(Type activityUnitGenusType) throws OperationFailedException, PermissionDeniedException
ActivityUnitList
corresponding to the given
activity unit genus Type
which does not include
activity units of types derived from the specified Type
.
In plenary mode, the returned list contains all known activity units
or an error results. Otherwise, the returned list may contain only
those activity units that are accessible through this session.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.activityUnitGenusType
- an activity unit genus type ActivityUnit
listNullArgumentException
- activityUnitGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnitsByParentGenusType(Type activityUnitGenusType) throws OperationFailedException, PermissionDeniedException
ActivityUnitList
corresponding to the given
activity unit genus Type
and include any additional
activity units with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
activity units or an error results. Otherwise, the returned list may
contain only those activity units that are accessible through this
session.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.activityUnitGenusType
- an activity unit genus type ActivityUnit
listNullArgumentException
- activityUnitGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnitsByRecordType(Type activityUnitRecordType) throws OperationFailedException, PermissionDeniedException
ActivityUnitList
containing the given activity
unit record Type.
In plenary mode, the returned list contains all known activity units
or an error results. Otherwise, the returned list may contain only
those activity units that are accessible through this session.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.activityUnitRecordType
- an activity unit record type ActivityUnit
listNullArgumentException
- activityUnitRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnitsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
ActivityUnitList
for the given course.
In plenary mode, the returned list contains all known activity units
or an error results. Otherwise, the returned list may contain only
those activity units that are accessible through this session.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned.courseId
- a course Id
ActivityUnit
listNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitList getActivityUnits() throws OperationFailedException, PermissionDeniedException
ActivityUnits.
In plenary mode, the returned list contains all known
activity units or an error results. Otherwise, the returned list may
contain only those activity units that are accessible through this
session.
In active mode, activity units are returned that are currently active.
In any status mode, active and inactive activity units are returned. ActivityUnits
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.