Interface CredentialEntrySmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CredentialEntryQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of CredentialEntries . The courses may be sequenced using the CredentialEntrySearchOrder from this session.

This CourseCatalog has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a CredentialEntryQueryInspector . The query may be modified by converting the inspector back to a CredentialEntryQuery .

  • Method Details

    • getCourseCatalogId

      Id getCourseCatalogId()
      Gets the CourseCatalog Id associated with this session.
      Returns:
      the CourseCatalog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalog

      CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog associated with this session.
      Returns:
      the course catalog
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartCourseCatalogs

      boolean canManageSmartCourseCatalogs()
      Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart course catalog management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntryQuery

      CredentialEntryQuery getCredentialEntryQuery()
      Gets a credential entry query.
      Returns:
      the credential entry query
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntrySearchOrder

      CredentialEntrySearchOrder getCredentialEntrySearchOrder()
      Gets a credential entry search order.
      Returns:
      the credential entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCredentialEntryQuery

      void applyCredentialEntryQuery(CredentialEntryQuery credentialEntryQuery) throws OperationFailedException, PermissionDeniedException
      Applies a credential entry query to this course catalog.
      Parameters:
      credentialEntryQuery - the credential entry query
      Throws:
      NullArgumentException - credentialEntryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - credentialEntryQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCredentialEntryQuery

      CredentialEntryQueryInspector inspectCredentialEntryQuery() throws OperationFailedException, PermissionDeniedException
      Gets a credential entry query inspector for this course catalog.
      Returns:
      the credential entry query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyCredentialEntrySequencing

      void applyCredentialEntrySequencing(CredentialEntrySearchOrder credentialEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a credential entry search order to this course catalog.
      Parameters:
      credentialEntrySearchOrder - the credential entry search order
      Throws:
      NullArgumentException - credentialEntrySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - credentialEntrySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntryQueryFromInspector

      CredentialEntryQuery getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)
      Gets a credential entry query from an inspector.
      Parameters:
      credentialEntryQueryInspector - a query inspector
      Returns:
      the credential entry query
      Throws:
      NullArgumentException - credentialEntryQueryInspector is null
      UnsupportedException - credentialEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.