Interface ActivityRegistrationLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
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:

  • 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 activity registration methods in this session operate, retrieve and pertain to activity registrations defined explicitly in the current course catalog. Using an isolated view is useful for managing ActivityRegistrations with the ActivityRegistrationAdminSession .
  • federated course catalog view: All activity registration lookup methods in this session operate, retrieve and pertain to all activity registrations defined in this course catalog and any other activity registrations implicitly available in this course catalog through course catalog inheritence.
  • effective vote view: All activity registration lookup methods return registrations where the current date falls in between the effective dates inclusive.
  • any effective vote view: Activity 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.

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 .

  • 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.

    • canLookupActivityRegistrations

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

    • useComparativeActivityRegistrationView

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

    • usePlenaryActivityRegistrationView

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

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include activity 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.

    • useEffectiveActivityRegistrationView

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

    • useAnyEffectiveActivityRegistrationView

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

    • getActivityRegistration

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

    • getActivityRegistrationsByIds

      ActivityRegistrationList getActivityRegistrationsByIds(IdList activityRegistrationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an 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.
      Parameters:
      activityRegistrationIds - the list of Ids to retrieve
      Returns:
      the returned ActivityRegistration list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - activityRegistrationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationsByGenusType

      ActivityRegistrationList getActivityRegistrationsByGenusType(Type activityRegistrationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an 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.
      Parameters:
      activityRegistrationGenusType - an activity registration genus type
      Returns:
      the returned ActivityRegistration list
      Throws:
      NullArgumentException - activityRegistrationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationsByParentGenusType

      ActivityRegistrationList getActivityRegistrationsByParentGenusType(Type activityRegistrationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an 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.
      Parameters:
      activityRegistrationGenusType - an activity registration genus type
      Returns:
      the returned ActivityRegistration list
      Throws:
      NullArgumentException - activityRegistrationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationsByRecordType

      ActivityRegistrationList getActivityRegistrationsByRecordType(Type activityRegistrationRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an 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.
      Parameters:
      activityRegistrationRecordType - an activity registration record type
      Returns:
      the returned ActivityRegistration list
      Throws:
      NullArgumentException - activityRegistrationRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationsOnDate

      ActivityRegistrationList getActivityRegistrationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      a list of ActivityRegistrations
      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.

    • getActivityRegistrationsForRegistration

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

    • getActivityRegistrationsForRegistrationOnDate

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

    • getActivityRegistrationsForActivity

      ActivityRegistrationList getActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      activityId - an activity Id
      Returns:
      a list of ActivityRegistrations
      Throws:
      NullArgumentException - activityId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationsForActivityOnDate

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

    • getActivityRegistrationsForStudent

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

    • getActivityRegistrationsForStudentOnDate

      ActivityRegistrationList getActivityRegistrationsForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      a list of ActivityRegistrations
      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.

    • getActivityRegistrationsForActivityAndStudent

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

    • getActivityRegistrationsForActivityAndStudentOnDate

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

    • getActivityRegistrationsForCourseOffering

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

    • getActivityRegistrationsForCourseOfferingOnDate

      ActivityRegistrationList getActivityRegistrationsForCourseOfferingOnDate(Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      from - start of date range
      to - end of date range
      Returns:
      a list of ActivityRegistrations
      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.

    • getActivityRegistrationsForCourseOfferingAndStudent

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

    • getActivityRegistrationsForCourseOfferingAndStudentOnDate

      ActivityRegistrationList getActivityRegistrationsForCourseOfferingAndStudentOnDate(Id courseOfferingId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Parameters:
      courseOfferingId - a course offering Id
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      a list of ActivityRegistrations
      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.

    • getActivityRegistrations

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