Interface ValueQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ValueSearchSession
public interface ValueQuerySession extends OsidSession

This session provides methods for searching Values . The search query is constructed using the ValueQuery . The parameter Type also specifies the record for the value query.

Two views of the configuration data are defined;

  • federated: values defined in configurations that are a parent of this configuration in the configuration hierarchy are included
  • isolated: values are contained to within this configuration

  • Method Details

    • getConfigurationId

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

    • getConfiguration

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

    • canSearchValues

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

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      Federates the view for methods in this session. A federated view will include values from parent configurations in the configuration hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedConfigurationView

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

    • getValueQuery

      ValueQuery getValueQuery()
      Gets a value query.
      Returns:
      the value query
      Compliance:
      mandatory - This method must be implemented.

    • getValuesByQuery

      ValueList getValuesByQuery(ValueQuery valueQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Values matching the given value query.
      Parameters:
      valueQuery - the value query
      Returns:
      the returned ValueList
      Throws:
      NullArgumentException - valueQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - a query form is not of this service
      Compliance:
      mandatory - This method must be implemented.