org.apache.jackrabbit.rmi.remote

Interface RemoteQuery

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ServerQuery

public interface RemoteQuery
extends java.rmi.Remote

Remote version of the JCR Query interface. Used by the ServerQuery and ClientQuery adapter base classes to provide transparent RMI access to remote items.

RMI errors are signaled with RemoteExceptions.

See Also:

javax.jcr.query.Query, ClientQuery, ServerQuery

Method Summary

Modifier and Type	Method and Description
void	bindValue(java.lang.String varName, Value value)
RemoteQueryResult	execute()
java.lang.String[]	getBindVariableNames()
java.lang.String	getLanguage()
java.lang.String	getStatement()
java.lang.String	getStoredQueryPath()
void	setLimit(long limit)
void	setOffset(long offset)
RemoteNode	storeAsNode(java.lang.String absPath)

Method Detail

execute

RemoteQueryResult execute()
                   throws RepositoryException,
                          java.rmi.RemoteException

Returns:

a QueryResult

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#execute()

setLimit

void setLimit(long limit)
       throws java.rmi.RemoteException

Parameters:

limit - a long

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#setLimit()

setOffset

void setOffset(long offset)
        throws java.rmi.RemoteException

Parameters:

offset - a long

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#setOffset()

getStatement

java.lang.String getStatement()
                       throws java.rmi.RemoteException

Returns:

the query statement.

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#getStatement()

getLanguage

java.lang.String getLanguage()
                      throws java.rmi.RemoteException

Returns:

the query language.

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#getLanguage()

getStoredQueryPath

java.lang.String getStoredQueryPath()
                             throws RepositoryException,
                                    java.rmi.RemoteException

Returns:

path of the node representing this query.

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#getStoredQueryPath()

storeAsNode

RemoteNode storeAsNode(java.lang.String absPath)
                throws RepositoryException,
                       java.rmi.RemoteException

Parameters:

absPath - path at which to persist this query.

Returns:

stored node

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#storeAsNode(String)

bindValue

void bindValue(java.lang.String varName,
               Value value)
        throws RepositoryException,
               java.rmi.RemoteException

Parameters:

varName - name of variable in query

value - value to bind

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#bindValue(String, Value)

getBindVariableNames

java.lang.String[] getBindVariableNames()
                                 throws RepositoryException,
                                        java.rmi.RemoteException

Returns:

the names of the bind variables in this query.

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.query.Query#getBindVariableNames()