Interface RegistrationTargetCourseCatalogSession

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

This session provides methods to retrieve RegistrationT arget to CourseCatalog mappings. A RegistrationT arget 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

    • canLookupRegistrationTargetCourseCatalogMappings

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

    • useComparativeRegistrationTargetCourseCatalogView

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

    • usePlenaryRegistrationTargetCourseCatalogView

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

    • getRegistrationTargetIdsByCourseCatalog

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

    • getRegistrationTargetsByCourseCatalog

      RegistrationTargetList getRegistrationTargetsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of RegistrationTargets associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related registration targets
      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.

    • getRegistrationTargetIdsByCourseCatalogs

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

    • getRegistrationTargetsByCourseCatalogs

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

    • getCourseCatalogIdsByRegistrationTarget

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

    • getCourseCatalogsByRegistrationTarget

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