com.softwareag.eda.estore.query.api

Interface QuerySession

All Superinterfaces:

java.lang.AutoCloseable

public interface QuerySession
extends java.lang.AutoCloseable

This interface represents a "Session" in the Common Query API

Method Summary

Modifier and Type	Method and Description
void	close() Close the session and free any and all associated resources
FullTextQuery	createFullTextQuery() Create and return a full text query object.
Query	createQuery(java.lang.String queryString) Create and return a Query object based on the specified query string.
QuerySessionContext	getSessionContext() A context is used when creating every query session.

Method Detail

getSessionContext

QuerySessionContext getSessionContext()

A context is used when creating every query session. This method is provided to allow a caller to retrieve this context.

Returns:

the context used in the creation of this session.

createQuery

Query createQuery(java.lang.String queryString)
           throws QuerySessionException,
                  QueryException

Create and return a Query object based on the specified query string.

Parameters:

queryString - The query to be executed.

Returns:

a valid query reference

Throws:

QueryException - on if the query could not be constructed.

QuerySessionException - if the session is in an invalid state.

createFullTextQuery

FullTextQuery createFullTextQuery()
                           throws QuerySessionException,
                                  QueryException,
                                  UnsupportedFeatureException

Create and return a full text query object.

Returns:

a valid full text query reference

Throws:

QueryException - on if the full text query could not be constructed.

QuerySessionException - if the session is in an invalid state.

UnsupportedFeatureException - if full text search is not supported by the query implementation.

close

void close()
    throws QuerySessionException

Close the session and free any and all associated resources

Specified by:

close in interface java.lang.AutoCloseable

Throws:

QuerySessionException - if an error occurs while closing the session.