Interface CourseCatalogLookupSession

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

This session provides methods for retrieving CourseCatalogs . The CourseCatalog represents a collection of courses, offerings and tems.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the CourseCatalogs it can access, without breaking execution. However, an assessment may only be useful if all CourseCatalogs referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupCourseCatalogs

      boolean canLookupCourseCatalogs()
      Tests if this user can perform CourseCatalog lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are 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 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.

    • getCourseCatalog

      CourseCatalog getCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CourseCatalog may have a different Id than requested, such as the case where a duplicate Id was assigned to a CourseCatalog and retained for compatibility.
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      the course catalog
      Throws:
      NotFoundException - courseCatalogId not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getCourseCatalogsByIds

      CourseCatalogList getCourseCatalogsByIds(IdList courseCatalogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CourseCatalogList corresponding to the given IdList .In plenary mode, the returned list contains all of the course catalogs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CourseCatalogs may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      courseCatalogIds - the list of Ids to retrieve
      Returns:
      the returned CourseCatalog list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByGenusType

      CourseCatalogList getCourseCatalogsByGenusType(Type courseCatalogGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseCatalogList corresponding to the given course catalog genus Type which does not include course catalogs of types derived from the specified Type . In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.
      Parameters:
      courseCatalogGenusType - a course catalog genus type
      Returns:
      the returned CourseCatalog list
      Throws:
      NullArgumentException - courseCatalogGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByParentGenusType

      CourseCatalogList getCourseCatalogsByParentGenusType(Type courseCatalogGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseCatalogList corresponding to the given course catalog genus Type and include any additional course catalogs with genus types derived from the specified Type . In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.
      Parameters:
      courseCatalogGenusType - a course catalog genus type
      Returns:
      the returned CourseCatalog list
      Throws:
      NullArgumentException - courseCatalogGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByRecordType

      CourseCatalogList getCourseCatalogsByRecordType(Type courseCatalogRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseCatalogList containing the given course catalog record Type .In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.
      Parameters:
      courseCatalogRecordType - a course catalog record type
      Returns:
      the returned CourseCatalog list
      Throws:
      NullArgumentException - courseCatalogRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByProvider

      CourseCatalogList getCourseCatalogsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseCatalogList from the given provider. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned CourseCatalog list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogs

      CourseCatalogList getCourseCatalogs() throws OperationFailedException, PermissionDeniedException
      Gets all CourseCatalogs . In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.
      Returns:
      a list of CourseCatalogs
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.