Interface InputQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
InputSearchSession
public interface InputQuerySession extends OsidSession

This session provides methods for searching among Inputs. The search query is constructed using the InputQuery.

This session defines views that offer differing behaviors for searching.

  • federated trigger view: searches include inputs in triggers of which this trigger is an ancestor in the trigger hierarchy
  • isolated trigger view: searches are restricted to inputs in this trigger

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

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

    • canSearchInputs

      boolean canSearchInputs()
      Tests if this user can perform Input 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 inputs in systems which are children of this trigger 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.

    • getInputQuery

      InputQuery getInputQuery()
      Gets an input query.
      Returns:
      the input query
      Compliance:
      mandatory - This method must be implemented.

    • getInputsByQuery

      InputList getInputsByQuery(InputQuery inputQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Inputs matching the given input query.
      Parameters:
      inputQuery - the input query
      Returns:
      the returned InputList
      Throws:
      NullArgumentException - inputQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - inputQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.