Interface FunctionQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
FunctionSearchSession
public interface FunctionQuerySession extends OsidSession

This session provides methods for searching Function objects. The search query is constructed using the FunctionQuery . The function record Type also specifies the query record for the function query.

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchFunctions

      boolean canSearchFunctions()
      Tests if this user can perform Function 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 functions 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.

    • getFunctionQuery

      FunctionQuery getFunctionQuery()
      Gets a function query.
      Returns:
      the function query
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByQuery

      FunctionList getFunctionsByQuery(FunctionQuery functionQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Functions matching the given query.
      Parameters:
      functionQuery - the function query
      Returns:
      the returned FunctionList
      Throws:
      NullArgumentException - functionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - functionQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.