Interface QualifierQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QualifierSearchSession
public interface QualifierQuerySession extends OsidSession

This session provides methods for searching among Qualifier objects. The search query is constructed using the QualifierQuery. If more than one search element is specified within a single QualifierQuery, these elements form a boolean AND.

This session defines views that offer differing behaviors for searching.

  • federated vault view: searches include qualifiers in vaults of which this vault is an ancestor in the vault hierarchy
  • isolated vault view: searches are restricted to qualifiers in this vault

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

  • Method Details

    • getVaultId

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

    • getVault

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

    • canSearchQualifiers

      boolean canSearchQualifiers()
      Tests if this user can perform Qualifier 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.

    • useFederatedVaultView

      void useFederatedVaultView()
      Federates the view for methods in this session. A federated view will include qualifiers in vaults which are children of this vault in the vault hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedVaultView

      void useIsolatedVaultView()
      Isolates the view for methods in this session. An isolated view restricts searches to this vault only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQualifierQuery

      QualifierQuery getQualifierQuery()
      Gets a qualifier query.
      Returns:
      the qualifier query
      Compliance:
      mandatory - This method must be implemented.

    • getQualifiersByQuery

      QualifierList getQualifiersByQuery(QualifierQuery qualifierQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Qualifiers matching the given search.
      Parameters:
      qualifierQuery - the search query array
      Returns:
      the returned QualifierList
      Throws:
      NullArgumentException - qualifierQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - qualifierQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.