Interface ValueEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ValueEnablerSearchSession
public interface ValueEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated configuration view: searches include value enablers in configurations of which this configuration is an ancestor in the configuration hierarchy
  • isolated configuration view: searches are restricted to value enablers in this configuration

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

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchValueEnablers

      boolean canSearchValueEnablers()
      Tests if this user can perform ValueEnabler 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.

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      Federates the view for methods in this session. A federated view will include value enablers in configurations which are children of this broker 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 lookups to this configuration only.
      Compliance:
      mandatory - This method is must be implemented.

    • getValueEnablerQuery

      ValueEnablerQuery getValueEnablerQuery()
      Gets a value enabler query.
      Returns:
      the value enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersByQuery

      ValueEnablerList getValueEnablersByQuery(ValueEnablerQuery valueEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ValueEnablers matching the given value enabler query.
      Parameters:
      valueEnablerQuery - the value enabler query
      Returns:
      the returned ValueEnablerList
      Throws:
      NullArgumentException - valueEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - valueEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.