com.tibco.n2.service.adapter.binding

Interface ResourceQueryService

All Known Implementing Classes:

ResourceQueryService

public interface ResourceQueryService

Interface to provide the ResourceQueryService methods.

©2008 Cloud Software Group, Inc.

Method Summary

Modifier and Type	Method and Description
com.tibco.n2.de.api.resourcequery.XmlSimpleResource[]	executeQuery(int aModelVersion, java.lang.String aQuery) Executes a given query against the Directory Engine.
com.tibco.n2.de.api.resourcequery.XmlSimpleResource[]	executeQuery(int aModelVersion, java.lang.String aQuery, boolean aSingleResult, int aImplementation) Executes a given query against the Directory Engine; with the option to return only a single result - chosen at random from the collection of results.
com.tibco.n2.de.api.resourcequery.XmlSimpleResource[]	executeQuery(java.lang.String aQuery) Executes a given query against the Directory Engine.
java.lang.String	resetQueries() Resets dynamic queries in the Directory Engine.
java.lang.String	resetQueries(int aModelVersion) Resets dynamic queries in the Directory Engine.

Method Detail

executeQuery

com.tibco.n2.de.api.resourcequery.XmlSimpleResource[] executeQuery(java.lang.String aQuery)
                                                            throws com.tibco.n2.de.services.InternalServiceFault,
                                                                   com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                   com.tibco.n2.de.services.InvalidQueryFault,
                                                                   com.tibco.n2.de.services.NoSuchNamedEntityFault

Executes a given query against the Directory Engine.

Parameters:

aQuery - the RQL expression to be evaluated.

Returns:

the collection of Resources identified by the given query.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InvalidQueryFault

com.tibco.n2.de.services.NoSuchNamedEntityFault

executeQuery

com.tibco.n2.de.api.resourcequery.XmlSimpleResource[] executeQuery(int aModelVersion,
                                                                   java.lang.String aQuery)
                                                            throws com.tibco.n2.de.services.InternalServiceFault,
                                                                   com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                   com.tibco.n2.de.services.InvalidQueryFault,
                                                                   com.tibco.n2.de.services.NoSuchNamedEntityFault

Executes a given query against the Directory Engine.

Parameters:

aModelVersion - the major org-model version against which the query should be evaluated.

aQuery - the RQL expression to be evaluated.

Returns:

the collection of Resources identified by the given query.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InvalidQueryFault

com.tibco.n2.de.services.NoSuchNamedEntityFault

executeQuery

com.tibco.n2.de.api.resourcequery.XmlSimpleResource[] executeQuery(int aModelVersion,
                                                                   java.lang.String aQuery,
                                                                   boolean aSingleResult,
                                                                   int aImplementation)
                                                            throws com.tibco.n2.de.services.InternalServiceFault,
                                                                   com.tibco.n2.de.services.InvalidServiceRequestFault,
                                                                   com.tibco.n2.de.services.InvalidQueryFault,
                                                                   com.tibco.n2.de.services.NoSuchNamedEntityFault

Executes a given query against the Directory Engine; with the option to return only a single result - chosen at random from the collection of results.

Parameters:

aModelVersion - the major org-model version against which the query should be evaluated.

aQuery - the RQL expression to be evaluated.

Returns:

the collection of Resources identified by the given query.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidServiceRequestFault

com.tibco.n2.de.services.InvalidQueryFault

com.tibco.n2.de.services.NoSuchNamedEntityFault

resetQueries

java.lang.String resetQueries()
                       throws com.tibco.n2.de.services.InternalServiceFault

Resets dynamic queries in the Directory Engine.

Parameters:

aModelVersion -

Returns:

none.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault

resetQueries

java.lang.String resetQueries(int aModelVersion)
                       throws com.tibco.n2.de.services.InternalServiceFault

Resets dynamic queries in the Directory Engine.

Parameters:

aModelVersion -

Returns:

none.

Throws:

java.lang.RuntimeException

com.tibco.n2.de.services.InternalServiceFault