Interface KeySmartAgencySession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A KeyQuery can be retrieved from this session and mapped to this Agency to create a virtual collection of Keys . The keys may be sequenced using the KeySearchOrder from this session.

This Agency has a default query that matches any key and a default search order that specifies no sequencing. The queries may be examined using an KeyQueryInspector . The query may be modified by converting the inspector back to an KeyQuery .

  • Method Details

    • getAgencyId

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

    • getAgency

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

    • canManageSmartAgencies

      boolean canManageSmartAgencies()
      Tests if this user can manage smart agencies. 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 agency management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getKeyQuery

      KeyQuery getKeyQuery()
      Gets a key query.
      Returns:
      the key query
      Compliance:
      mandatory - This method must be implemented.

    • getKeySearchOrder

      KeySearchOrder getKeySearchOrder()
      Gets a key search order.
      Returns:
      the key search order
      Compliance:
      mandatory - This method must be implemented.

    • applyKeyQuery

      void applyKeyQuery(KeyQuery keyQuery) throws OperationFailedException, PermissionDeniedException
      Applies a key query to this agency.
      Parameters:
      keyQuery - the key query
      Throws:
      NullArgumentException - keyQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - keyQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectKeyQuery

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

    • applyKeySequencing

      void applyKeySequencing(KeySearchOrder keySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a key search order to this agency.
      Parameters:
      keySearchOrder - the key search order
      Throws:
      NullArgumentException - keySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - keySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getKeyQueryFromInspector

      KeyQuery getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)
      Gets a key query from an inspector.
      Parameters:
      keyQueryInspector - a query inspector
      Returns:
      the key query
      Throws:
      NullArgumentException - keyQueryInspector is null
      UnsupportedException - keyQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.