public interface RegistrationLookupSession extends OsidSession
This session defines methods for retrieving registrations. A
Registration
is a relationship between a student and an
ActivityBundle.
This lookup session defines several views:
Registrations
with the
RegistrationAdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Registrations may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Registration.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRegistrations()
Tests if this user can perform
Registration lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
Registration |
getRegistration(Id registrationId)
Gets the
Registration specified by its Id. |
RegistrationList |
getRegistrations()
Gets all
Registrations. |
RegistrationList |
getRegistrationsByGenusType(Type registrationGenusType)
Gets a
RegistrationList corresponding to the given
registration genus Type which does not include
registrations of types derived from the specified Type. |
RegistrationList |
getRegistrationsByIds(IdList registrationIds)
Gets a
RegistrationList corresponding to the given
IdList. |
RegistrationList |
getRegistrationsByParentGenusType(Type registrationGenusType)
Gets a
RegistrationList corresponding to the given
course genus Type and include any additional
registrations with genus types derived from the specified Type. |
RegistrationList |
getRegistrationsByRecordType(Type registrationRecordType)
Gets a
RegistrationList containing the given
registration record Type. |
RegistrationList |
getRegistrationsForActivityBundle(Id activityBundleId)
Gets all
Registrations associated with a given
ActivityBundle. |
RegistrationList |
getRegistrationsForActivityBundleAndStudent(Id activityBundleId,
Id resourceId)
Gets all
Registrations for a given activity bundle and
student. |
RegistrationList |
getRegistrationsForActivityBundleAndStudentOnDate(Id activityBundleId,
Id resourceId,
DateTime from,
DateTime to)
Gets all
Registrations for an activity bundle and
student effective during the entire given date range inclusive but not
confined to the date range. |
RegistrationList |
getRegistrationsForActivityBundleOnDate(Id activityBundleId,
DateTime from,
DateTime to)
Gets all
Registrations effective during the entire
given date range inclusive but not confined to the date range. |
RegistrationList |
getRegistrationsForCourseOffering(Id courseOfferingId)
Gets all
Registrations related to a course offering. |
RegistrationList |
getRegistrationsForCourseOfferingAndStudent(Id courseOfferingId,
Id resourceId)
Gets all
Registrations for a given course offering and
student. |
RegistrationList |
getRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId,
Id resourceId,
DateTime from,
DateTime to)
Gets all
Registrations for a course offering and
student effective during the entire given date range inclusive but not
confined to the date range. |
RegistrationList |
getRegistrationsForCourseOfferingOnDate(Id courseOfferingId,
DateTime from,
DateTime to)
Gets all
Registrations for a course offering effective
during the entire given date range inclusive but not confined to the
date range. |
RegistrationList |
getRegistrationsForStudent(Id resourceId)
Gets all
Registrations for a given student. |
RegistrationList |
getRegistrationsForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets all
Registrations for a student effective during
the entire given date range inclusive but not confined to the date
range. |
RegistrationList |
getRegistrationsOnDate(DateTime from,
DateTime to)
Gets all
Registrations effective during the entire
given date range inclusive but not confined to the date range. |
void |
useAnyEffectiveRegistrationView()
All registrations of any effective dates are returned by methods in
this session.
|
void |
useComparativeRegistrationView()
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 |
useEffectiveRegistrationView()
Only 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 |
usePlenaryRegistrationView()
A complete view of the
Registration 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 canLookupRegistrations()
Registration
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 useComparativeRegistrationView()
mandatory
- This method is must be implemented. void usePlenaryRegistrationView()
Registration
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 useEffectiveRegistrationView()
mandatory
- This method is must be implemented. void useAnyEffectiveRegistrationView()
mandatory
- This method is must be implemented. Registration getRegistration(Id registrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Registration
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Registration
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, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.registrationId
- the Id
of the
Registration
to retrieve Registration
NotFoundException
- no Registration
found with the given Id
NullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsByIds(IdList registrationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RegistrationList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
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 Registrations
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.registrationIds
- the list of Ids
to retrieve Registration
listNotFoundException
- an Id was
not foundNullArgumentException
- registrationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsByGenusType(Type registrationGenusType) throws OperationFailedException, PermissionDeniedException
RegistrationList
corresponding to the given
registration genus Type
which does not include
registrations of types derived from the specified Type.
In plenary mode, the returned list contains all known
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.registrationGenusType
- a registration genus type Registration
listNullArgumentException
- registrationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsByParentGenusType(Type registrationGenusType) throws OperationFailedException, PermissionDeniedException
RegistrationList
corresponding to the given
course genus Type
and include any additional
registrations with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
registrations or an error results. Otherwise, the returned list may
contain only those registrations that are accessible through this
session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.registrationGenusType
- a registration genus type Registration
listNullArgumentException
- registrationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsByRecordType(Type registrationRecordType) throws OperationFailedException, PermissionDeniedException
RegistrationList
containing the given
registration record Type.
In plenary mode, the returned list contains all known courses or an
error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.registrationRecordType
- a registration record type Registration
listNullArgumentException
- registrationRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.from
- start of date rangeto
- end of date range Registrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForActivityBundle(Id activityBundleId) throws OperationFailedException, PermissionDeniedException
Registrations
associated with a given
ActivityBundle.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.activityBundleId
- an activity bundle Id
Registrations
NullArgumentException
- activityBundleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForActivityBundleOnDate(Id activityBundleId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.activityBundleId
- an activity bundle Id
from
- start of date rangeto
- end of date range Registrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityBundleId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
Registrations
for a given student.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.resourceId
- a resource Id
Registrations
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
for a 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 registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range Registrations
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. RegistrationList getRegistrationsForActivityBundleAndStudent(Id activityBundleId, Id resourceId) throws OperationFailedException, PermissionDeniedException
Registrations
for a given activity bundle and
student.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.activityBundleId
- an activity bundle Id
resourceId
- a resource Id
Registrations
NullArgumentException
- activityBundleId
or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForActivityBundleAndStudentOnDate(Id activityBundleId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
for an activity bundle 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 registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.activityBundleId
- an activity bundle Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range Registrations
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityBundleId,
resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
Registrations
related to a course offering.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.courseOfferingId
- a course offering Id
Registrations
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForCourseOfferingOnDate(Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
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 registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.courseOfferingId
- a course offering Id
from
- start of date rangeto
- end of date range Registrations
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. RegistrationList getRegistrationsForCourseOfferingAndStudent(Id courseOfferingId, Id resourceId) throws OperationFailedException, PermissionDeniedException
Registrations
for a given course offering and
student.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned.courseOfferingId
- a course offering Id
resourceId
- a resource Id
Registrations
NullArgumentException
- courseOfferingId
or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RegistrationList getRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Registrations
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 registrations or
an error results. Otherwise, the returned list may contain only those
registrations that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective 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 Registrations
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. RegistrationList getRegistrations() throws OperationFailedException, PermissionDeniedException
Registrations.
In plenary mode, the returned list contains all known registrations or
an error results. Otherwise, the returned list may contain only those
courses that are accessible through this session.
In effective mode, registrations are returned that are currently
effective. In any effective mode, effective registrations and those
currently expired are returned. Registrations
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.