Interface RegistrationRequestItemCourseCatalogSession

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

This session provides methods to retrieve RegistrationR equestItem to CourseCatalog mappings. A RegistrationR equestItem may appear in multiple CourseCatalog obj ects. 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

    • canLookupRegistrationRequestItemCourseCatalogMappings

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

    • useComparativeRegistrationRequestItemCourseCatalogView

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

    • usePlenaryRegistrationRequestItemCourseCatalogView

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

    • getRegistrationRequestItemIdsByCourseCatalog

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

    • getRegistrationRequestItemsByCourseCatalog

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

    • getRegistrationRequestItemIdsByCourseCatalogs

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

    • getRegistrationRequestItemsByCourseCatalogs

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

    • getCourseCatalogIdsByRegistrationRequestItem

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

    • getCourseCatalogsByRegistrationRequestItem

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