javax.xml.xquery
Interface XQExprCommons

All Superinterfaces:
XQDynamicContext
All Known Subinterfaces:
XQExpression, XQPreparedExpression
All Known Implementing Classes:
XQAbstractExprCommons, XQExprCommonsImpl, XQExpressionImpl, XQPreparedExpressionImpl

public interface XQExprCommons
extends XQDynamicContext

This interface is not part of the XQuery API. It has been introduced to hold methods shared between XQExpression and XQPreparedExpression.

Author:
Michael Stark

Method Summary
 void cancel()
          Attempts to cancel the execution of the XQExpression if both the XQuery data source and the XQJ driver support aborting the execution of an XQExpression.
 void clearWarnings()
          Clears the list of warnings associated with this expression.
 void close()
          Closes the expression object and release associated resources.
 int getQueryTimeout()
          Retrieves the number of seconds that the driver will wait for the expression to execute.
 XQWarning getWarnings()
          Gets the first warning in a chained list of warnings associated with this expression.
 boolean isClosed()
          Checks if the expression is in a closed state.
 void setQueryTimeout(int seconds)
          Sets the number of seconds the driver will wait for the expression to execute.
 
Methods inherited from interface javax.xml.xquery.XQDynamicContext
bindBase64Binary, bindBoolean, bindByte, bindContextItem, bindDecimal, bindDouble, bindFloat, bindHexBinary, bindInt, bindItem, bindLexicalValue, bindLong, bindNode, bindNotation, bindSequence, bindString, bindTime, bindTimestamp, bindURI, getImplicitTimeZone, setImplicitTimeZone
 

Method Detail

cancel

void cancel()
            throws XQException
Attempts to cancel the execution of the XQExpression if both the XQuery data source and the XQJ driver support aborting the execution of an XQExpression.

Throws:
XQException

clearWarnings

void clearWarnings()
                   throws XQException
Clears the list of warnings associated with this expression.

Throws:
XQException

close

void close()
           throws XQException
Closes the expression object and release associated resources.

Throws:
XQException

getQueryTimeout

int getQueryTimeout()
                    throws XQException
Retrieves the number of seconds that the driver will wait for the expression to execute.

Throws:
XQException

getWarnings

XQWarning getWarnings()
                      throws XQException
Gets the first warning in a chained list of warnings associated with this expression.

Throws:
XQException

isClosed

boolean isClosed()
Checks if the expression is in a closed state.


setQueryTimeout

void setQueryTimeout(int seconds)
                     throws XQException
Sets the number of seconds the driver will wait for the expression to execute.

Throws:
XQException