Interface FunctionSmartVaultSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A FunctionQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Functions . The functions may be sequenced using the FunctionSearchOrder from this session.

This Vault has a default query that matches any function and a default search order that specifies no sequencing. The queries may be examined using a FunctionQueryInspector . The query may be modified by converting the inspector back to a 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.

    • canManageSmartVaults

      boolean canManageSmartVaults()
      Tests if this user can manage smart vaults. A return of true does not guarantee successful authorization. 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 vault management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionQuery

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

    • getFunctionSearchOrder

      FunctionSearchOrder getFunctionSearchOrder()
      Gets a function search order.
      Returns:
      the function search order
      Compliance:
      mandatory - This method must be implemented.

    • applyFunctionQuery

      void applyFunctionQuery(FunctionQuery functionQuery) throws OperationFailedException, PermissionDeniedException
      Applies a function query to this vault.
      Parameters:
      functionQuery - the function query
      Throws:
      NullArgumentException - functionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - functionQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectFunctionQuery

      FunctionQueryInspector inspectFunctionQuery() throws OperationFailedException, PermissionDeniedException
      Gets a function query inspector for this vault.
      Returns:
      the function query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyFunctionSequencing

      void applyFunctionSequencing(FunctionSearchOrder functionSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a function search order to this vault.
      Parameters:
      functionSearchOrder - the function search order
      Throws:
      NullArgumentException - functionSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - functionSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionQueryFromInspector

      FunctionQuery getFunctionQueryFromInspector(FunctionQueryInspector functionQueryInspector)
      Gets a function query from an inspector.
      Parameters:
      functionQueryInspector - a function query inspector
      Returns:
      the function query
      Throws:
      NullArgumentException - functionQueryInspector is null
      UnsupportedException - functionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.