Interface InputEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
InputEnablerSearchSession
public interface InputEnablerQuerySession extends OsidSession

This session provides methods for searching among InputEnabler objects. The search query is constructed using the InputEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include input enablers in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to input enablers in this system

input enablers may have a query record indicated by their respective record types. The query record is accessed via the InputEnablerQuery.

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canSearchInputEnablers

      boolean canSearchInputEnablers()
      Tests if this user can perform InputEnabler lookups. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include input enablers in systems which are children of this broker in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

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

    • getInputEnablerQuery

      InputEnablerQuery getInputEnablerQuery()
      Gets an input enabler query.
      Returns:
      the input enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getInputEnablersByQuery

      InputEnablerList getInputEnablersByQuery(InputEnablerQuery inputEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of InputEnablers matching the given search.
      Parameters:
      inputEnablerQuery - the input enabler query
      Returns:
      the returned InputEnablerList
      Throws:
      NullArgumentException - inputEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - inputEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.