Interface RegistrationLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RegistrationLookupSession extends OsidSession

This session defines methods for retrieving registrations. A Registration is a relationship between a student and an RegistrationTarget .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated course catalog view: All registration methods in this session operate, retrieve and pertain to registrations defined explicitly in the current course catalog. Using an isolated view is useful for managing Registrations with the RegistrationAdminSession .
  • federated course catalog view: All registration lookup methods in this session operate, retrieve and pertain to all registrations defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.
  • effective registration view: All registration lookup methods return registrations where the current date falls in between the effective dates inclusive.
  • any effective registration view: Registrations of any effective date are returned from methods.

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 .

  • Method Details

    • getCourseCatalogId

      Id getCourseCatalogId()
      Gets the CourseCatalog Id associated with this session.
      Returns:
      the CourseCatalog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalog

      CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog associated with this session.
      Returns:
      the course catalog
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupRegistrations

      boolean canLookupRegistrations()
      Tests if this user can perform 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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeRegistrationView

      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. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryRegistrationView

      void usePlenaryRegistrationView()
      A complete view of the 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.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include registrations in catalogs which are children of this catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveRegistrationView

      void useEffectiveRegistrationView()
      Only registrations whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveRegistrationView

      void useAnyEffectiveRegistrationView()
      All registrations of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getRegistration

      Registration getRegistration(Id registrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the 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.
      Parameters:
      registrationId - the Id of the Registration to retrieve
      Returns:
      the returned Registration
      Throws:
      NotFoundException - no Registration found with the given Id
      NullArgumentException - registrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByIds

      RegistrationList getRegistrationsByIds(IdList registrationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a RegistrationList corresponding to the given IdLis t. 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.
      Parameters:
      registrationIds - the list of Ids to retrieve
      Returns:
      the returned Registration list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - registrationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByGenusType

      RegistrationList getRegistrationsByGenusType(Type registrationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      registrationGenusType - a registration genus type
      Returns:
      the returned Registration list
      Throws:
      NullArgumentException - registrationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByParentGenusType

      RegistrationList getRegistrationsByParentGenusType(Type registrationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      registrationGenusType - a registration genus type
      Returns:
      the returned Registration list
      Throws:
      NullArgumentException - registrationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByRecordType

      RegistrationList getRegistrationsByRecordType(Type registrationRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      registrationRecordType - a registration record type
      Returns:
      the returned Registration list
      Throws:
      NullArgumentException - registrationRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsOnDate

      RegistrationList getRegistrationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForRegistrationTarget

      RegistrationList getRegistrationsForRegistrationTarget(Id registrationTargetId) throws OperationFailedException, PermissionDeniedException
      Gets all Registrations associated with a given RegistrationTarget . 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.
      Parameters:
      registrationTargetId - a registration target Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - registrationTargetId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForRegistrationTargetOnDate

      RegistrationList getRegistrationsForRegistrationTargetOnDate(Id registrationTargetId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      registrationTargetId - a registration target Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - registrationTargetId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForStudent

      RegistrationList getRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      resourceId - a resource Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForStudentOnDate

      RegistrationList getRegistrationsForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForRegistrationTargetAndStudent

      RegistrationList getRegistrationsForRegistrationTargetAndStudent(Id registrationTargetId, Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets all Registrations for a given registration target 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.
      Parameters:
      registrationTargetId - a registration target Id
      resourceId - a resource Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - registrationTargetId or resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForRegistrationTargetAndStudentOnDate

      RegistrationList getRegistrationsForRegistrationTargetAndStudentOnDate(Id registrationTargetId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all Registrations for an registration target 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.
      Parameters:
      registrationTargetId - a registration target Id
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - registrationTargetId, resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForCourseOffering

      RegistrationList getRegistrationsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - courseOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForCourseOfferingOnDate

      RegistrationList getRegistrationsForCourseOfferingOnDate(Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - courseOfferingId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForCourseOfferingAndStudent

      RegistrationList getRegistrationsForCourseOfferingAndStudent(Id courseOfferingId, Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      resourceId - a resource Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - courseOfferingId or resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsForCourseOfferingAndStudentOnDate

      RegistrationList getRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - courseOfferingId, resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByCourseRegistration

      RegistrationList getRegistrationsByCourseRegistration(Id courseRegistrationId) throws OperationFailedException, PermissionDeniedException
      Gets all Registrations for a course registration. 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.
      Parameters:
      courseRegistrationId - a course registration Id
      Returns:
      a list of Registrations
      Throws:
      NullArgumentException - courseRegistrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationsByCourseRegistrationOnDate

      RegistrationList getRegistrationsByCourseRegistrationOnDate(Id courseRegistrationId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all Registrations for a course 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 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.
      Parameters:
      courseRegistrationId - a course registration Id
      from - start of date range
      to - end of date range
      Returns:
      a list of Registrations
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - courseRegistrationId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrations

      RegistrationList getRegistrations() throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Returns:
      a list of Registrations
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.