Interface ProgramEntryCourseCatalogSession

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

This session provides methods to retrieve ProgramEntry to CourseCatalog mappings. A ProgramEntry may appear in multiple CourseCatalog objects. 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

    • canLookupCourseCatalogMappings

      boolean canLookupCourseCatalogMappings()
      Tests if this user can perform lookups of program entry/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.

    • useComparativeCourseCatalogView

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

    • usePlenaryCourseCatalogView

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

    • getProgramEntryIdsByCourseCatalog

      IdList getProgramEntryIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProgramEntry Ids associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related program entry 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.

    • getProgramEntriesByCourseCatalog

      ProgramEntryList getProgramEntriesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProgramEntries associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related program entries
      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.

    • getProgramEntryIdsByCourseCatalogs

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

    • getProgramEntriesByCourseCatalogs

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

    • getCourseCatalogIdsByProgramEntry

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

    • getCourseCatalogsByProgramEntry

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