public interface ActivityRegistrationLookupSession extends OsidSession
This session defines methods for retrieving activity registrations. An
ActivityRegistration
is a relationship between a student
and an Activity.
ActivityRegistrations
may
be implied from a Registration.
This lookup session defines several views:
ActivityRegistrations
with the ActivityRegistrationAdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Activity registrations may have an additional records indicated by
their respective record types. The record may not be accessed through a
cast of the ActivityRegistration.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupActivityRegistrations()
Tests if this user can perform
ActivityRegistration
lookups. |
ActivityRegistration |
getActivityRegistration(Id activityRegistrationId)
Gets the
ActivityRegistration specified by its
Id. |
ActivityRegistrationList |
getActivityRegistrations()
Gets all
ActivityRegistrations. |
ActivityRegistrationList |
getActivityRegistrationsByGenusType(Type activityRegistrationGenusType)
Gets an
ActivityRegistrationList corresponding to the
given activity registration genus Type which does not
include activity registrations of types derived from the specified
Type. |
ActivityRegistrationList |
getActivityRegistrationsByIds(IdList activityRegistrationIds)
Gets an
ActivityRegistrationList corresponding to the
given IdList. |
ActivityRegistrationList |
getActivityRegistrationsByParentGenusType(Type activityRegistrationGenusType)
Gets an
ActivityRegistrationList corresponding to the
given course genus Type and include any additional
activity registrations with genus types derived from the specified
Type. |
ActivityRegistrationList |
getActivityRegistrationsByRecordType(Type activityRegistrationRecordType)
Gets an
ActivityRegistrationList containing the given
activity registration record Type. |
ActivityRegistrationList |
getActivityRegistrationsForActivity(Id activityId)
Gets all
ActivityRegistrations associated with a given
Activity. |
ActivityRegistrationList |
getActivityRegistrationsForActivityAndStudent(Id activityId,
Id resourceId)
Gets all
ActivityRegistrations for a given activity and
student. |
ActivityRegistrationList |
getActivityRegistrationsForActivityAndStudentOnDate(Id activityId,
Id resourceId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for an activity and
student during the entire given date range inclusive but not confined
to the date range. |
ActivityRegistrationList |
getActivityRegistrationsForActivityOnDate(Id activityId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for the given activity
and effective during the entire given date range inclusive but not
confined to the date range. |
ActivityRegistrationList |
getActivityRegistrationsForCourseOffering(Id courseOfferingId)
Gets all
ActivityRegistrations related to a course
offering. |
ActivityRegistrationList |
getActivityRegistrationsForCourseOfferingAndStudent(Id courseOfferingId,
Id resourceId)
Gets all
ActivityRegistrations for a given course
offering and student. |
ActivityRegistrationList |
getActivityRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId,
Id resourceId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for a course offering
and student effective during the entire given date range inclusive but
not confined to the date range. |
ActivityRegistrationList |
getActivityRegistrationsForCourseOfferingOnDate(Id courseOfferingId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for a course offering
effective during the entire given date range inclusive but not
confined to the date range. |
ActivityRegistrationList |
getActivityRegistrationsForRegistration(Id registrationId)
Gets all
ActivityRegistrations for a registration. |
ActivityRegistrationList |
getActivityRegistrationsForRegistrationOnDate(Id registrationId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for a registration and
effective during the entire given date range inclusive but not
confined to the date range. |
ActivityRegistrationList |
getActivityRegistrationsForStudent(Id resourceId)
Gets all
ActivityRegistrations for a given student. |
ActivityRegistrationList |
getActivityRegistrationsForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets all
ActivityRegistrations for a student during the
entire given date range inclusive but not confined to the date range. |
ActivityRegistrationList |
getActivityRegistrationsOnDate(DateTime from,
DateTime to)
Gets all
ActivityRegistrations effective during the
entire given date range inclusive but not confined to the date range. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
useAnyEffectiveActivityRegistrationView()
All activity registrations of any effective dates are returned by
methods in this session.
|
void |
useComparativeActivityRegistrationView()
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 |
useEffectiveActivityRegistrationView()
Only activity registrations whose effective dates are current are
returned by methods in this session.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryActivityRegistrationView()
A complete view of the
ActivityRegistration 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 canLookupActivityRegistrations()
ActivityRegistration
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 useComparativeActivityRegistrationView()
mandatory
- This method is must be implemented. void usePlenaryActivityRegistrationView()
ActivityRegistration
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 useEffectiveActivityRegistrationView()
mandatory
- This method is must be implemented. void useAnyEffectiveActivityRegistrationView()
mandatory
- This method is must be implemented. ActivityRegistration getActivityRegistration(Id activityRegistrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityRegistration
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ActivityRegistration
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a Course
and retained for
compatibility.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityRegistrationId
- the Id
of the
ActivityRegistration
to retrieve ActivityRegistration
NotFoundException
- no ActivityRegistration
found with the given Id
NullArgumentException
- activityRegistrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsByIds(IdList activityRegistrationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityRegistrationList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
activity registrations 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 ActivityRegistrations
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityRegistrationIds
- the list of Ids
to
retrieve ActivityRegistration
listNotFoundException
- an Id was
not foundNullArgumentException
- activityRegistrationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsByGenusType(Type activityRegistrationGenusType) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationList
corresponding to the
given activity registration genus Type
which does not
include activity registrations of types derived from the specified
Type.
In plenary mode, the returned list contains all known
activity registrations or an error results. Otherwise, the returned
list may contain only those activity registrations that are accessible
through this session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityRegistrationGenusType
- an activity registration genus
type ActivityRegistration
listNullArgumentException
-
activityRegistrationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsByParentGenusType(Type activityRegistrationGenusType) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationList
corresponding to the
given course genus Type
and include any additional
activity registrations with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
activity registrations or an error results. Otherwise, the returned
list may contain only those activity registrations that are accessible
through this session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityRegistrationGenusType
- an activity registration genus
type ActivityRegistration
listNullArgumentException
-
activityRegistrationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsByRecordType(Type activityRegistrationRecordType) throws OperationFailedException, PermissionDeniedException
ActivityRegistrationList
containing the given
activity registration record Type.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those activity registrations that are accessible through
this session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityRegistrationRecordType
- an activity registration record
type ActivityRegistration
listNullArgumentException
-
activityRegistrationRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
effective during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a registration.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.registrationId
- a registration Id
ActivityRegistrations
NullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForRegistrationOnDate(Id registrationId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a registration and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.registrationId
- a registration Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- registrationId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
associated with a given
Activity.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityId
- an activity Id
ActivityRegistrations
NullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForActivityOnDate(Id activityId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for the given activity
and effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityId
- an activity Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a given student.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.resourceId
- a resource Id
ActivityRegistrations
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a student during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForActivityAndStudent(Id activityId, Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a given activity and
student.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityId
- an activity Id
resourceId
- a resource Id
ActivityRegistrations
NullArgumentException
- activityId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForActivityAndStudentOnDate(Id activityId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for an activity and
student during the entire given date range inclusive but not confined
to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.activityId
- an activity Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
related to a course
offering.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.courseOfferingId
- a course offering Id
ActivityRegistrations
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForCourseOfferingOnDate(Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a course offering
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.courseOfferingId
- a course offering Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- courseOfferingId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForCourseOfferingAndStudent(Id courseOfferingId, Id resourceId) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a given course
offering and student.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.courseOfferingId
- a course offering Id
resourceId
- a resource Id
ActivityRegistrations
NullArgumentException
- courseOfferingId
or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
for a course offering
and student effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned.courseOfferingId
- a course offering Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range ActivityRegistrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- courseOfferingId,
resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrations() throws OperationFailedException, PermissionDeniedException
ActivityRegistrations.
In plenary mode, the returned list contains all known activity
registrations or an error results. Otherwise, the returned list may
contain only those activity registrations that are accessible through
this session.
In effective mode, activity registrations are returned that are
currently effective. In any effective mode, effective activity
registrations and those currently expired are returned. ActivityRegistrations
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.