Interface RegistrationRequestCourseCatalogSession

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

This session provides methods to retrieve RegistrationR equest to CourseCatalog mappings. A RegistrationR equest may appear in multiple CourseCatalogs . Each course 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

    • canLookupRegistrationRequestCourseCatalogMappings

      boolean canLookupRegistrationRequestCourseCatalogMappings()
      Tests if this user can perform lookups of registration request/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. T his 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.

    • useComparativeRegistrationRequestCourseCatalogView

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

    • usePlenaryRegistrationRequestCourseCatalogView

      void usePlenaryRegistrationRequestCourseCatalogView()
      A complete view of the RegistrationRequest 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.

    • getRegistrationRequestIdsByCourseCatalog

      IdList getRegistrationRequestIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of RegistrationRequestIds associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related registration request 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.

    • getRegistrationRequestsByCourseCatalog

      RegistrationRequestList getRegistrationRequestsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of RegistrationRequests associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related registration requests
      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.

    • getRegistrationRequestIdsByCourseCatalogs

      IdList getRegistrationRequestIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of RegistrationRequestIds corresponding to a list of Course Catalogs .
      Parameters:
      courseCatalogIds - list of course catalog Ids
      Returns:
      list of registration request Ids
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestsByCourseCatalogs

      RegistrationRequestList getRegistrationRequestsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of RegistrationRequest corresponding to a list of Course Catalogs .
      Parameters:
      courseCatalogIds - list of course catalog Ids
      Returns:
      list of registration requests
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogIdsByRegistrationRequest

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

    • getCourseCatalogsByRegistrationRequest

      CourseCatalogList getCourseCatalogsByRegistrationRequest(Id registrationRequestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalogs mapped to a RegistrationRequest .
      Parameters:
      registrationRequestId - Id of a RegistrationRequest
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - registrationRequestId is not found
      NullArgumentException - registrationRequestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.