Interface CredentialQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CredentialSearchSession
public interface CredentialQuerySession extends OsidSession

This session provides methods for searching among Credentials. The search query is constructed using the CredentialQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include credentials in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to credentials in this course catalog

Credentials may have a query record indicated by their respective record types. The query record is accessed via the CredentialQuery .

  • 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.

    • canSearchCredentials

      boolean canSearchCredentials()
      Tests if this user can perform Credential searches. 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 search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include credentials in course catalog which are children of this course catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • getCredentialQuery

      CredentialQuery getCredentialQuery()
      Gets a credential query.
      Returns:
      the credential query
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialsByQuery

      CredentialList getCredentialsByQuery(CredentialQuery credentialQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Credentials matching the given credential query.
      Parameters:
      credentialQuery - the credential query
      Returns:
      the returned CredentialList
      Throws:
      NullArgumentException - credentialQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - credentialQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.