Interface AuthorizationSmartVaultSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuthorizationQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Authorizations . The authorizations may be sequenced using the AuthorizationSearchOrder from this session.

This Vault has a default query that matches any authorization and a default search order that specifies no sequencing. The queries may be examined using a AuthorizationQueryInspector . The query may be modified by converting the inspector back to a AuthorizationQuery .

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

    • canManageSmartVault

      boolean canManageSmartVault()
      Tests if this user can manage smart vault. 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.

    • getAuthorizationQuery

      AuthorizationQuery getAuthorizationQuery()
      Gets an authorization query.
      Returns:
      the authorization query
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationSearchOrder

      AuthorizationSearchOrder getAuthorizationSearchOrder()
      Gets an authorization search order.
      Returns:
      the authorization search order.
      Compliance:
      mandatory - This method must be implemented.

    • applyAuthorizationQuery

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

    • inspectAuthorizationQuery

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

    • applyAuthorizationSequencing

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

    • getAuthorizationQueryFromInspector

      AuthorizationQuery getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector)
      Gets an authorization query from an inspector.
      Parameters:
      authorizationQueryInspector - a resorce relationship query inspector
      Returns:
      the authorization query
      Throws:
      NullArgumentException - authorizationQueryInspector is null
      UnsupportedException - authorizationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.