Interface EnrollmentCourseCatalogSession

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

This session provides methods to retrieve Enrollment to CourseCatalog mappings. An Enrollment may appear in multiple CourseCatalogs . Each catalog may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupEnrollmentCatalogMappings

      boolean canLookupEnrollmentCatalogMappings()
      Tests if this user can perform lookups of enrollment/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeEnrollmentCatalogView

      void useComparativeEnrollmentCatalogView()
      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.

    • usePlenaryEnrollmentCatalogView

      void usePlenaryEnrollmentCatalogView()
      A complete view of the Enrollment and CourseCatalog 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.

    • getEnrollmentIdsByCatalog

      IdList getEnrollmentIdsByCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of Enrollment Ids associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related enrollment Ids
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEnrollmentsByCatalog

      EnrollmentList getEnrollmentsByCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of Enrollments associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related enrollments
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEnrollmentIdsByCatalogs

      IdList getEnrollmentIdsByCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
      Gets the list of Enrollment Ids corresponding to a list of CourseCatalog objects.
      Parameters:
      courseCatalogIdList - list of course catalog Ids
      Returns:
      list of enrollment Ids
      Throws:
      NullArgumentException - courseCatalogIdList is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEnrollmentsByCatalogs

      EnrollmentList getEnrollmentsByCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
      Gets the list of Enrollments corresponding to a list of CourseCatalog objects.
      Parameters:
      courseCatalogIdList - list of course catalog Ids
      Returns:
      list of enrollments
      Throws:
      NullArgumentException - courseCatalogIdList is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogIdsByEnrollment

      IdList getCatalogIdsByEnrollment(Id enrollmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog Ids mapped to an Enrollment .
      Parameters:
      enrollmentId - Id of an Enrollment
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - enrollmentId is not found
      NullArgumentException - enrollmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogsByEnrollment

      CourseCatalogList getCatalogsByEnrollment(Id enrollmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog objects mapped to an Enrollment .
      Parameters:
      enrollmentId - Id of an Enrollment
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - enrollmentId is not found
      NullArgumentException - enrollmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.