The PerformRQLQuery Web service executes a given RQL string on the repository specified by the pRepositoryPath argument, and returns items of the type specified by the pItemDescriptorName argument. The given RQL string cannot contain parameters, since RQL expects parameters in the form of an array of Objects. The Web service calls through to the performRQLQuery method of the atg.repository.RepositoryServices class, which handles all logic, error checking, and result transformation.

Web Service Implementation

Web Service URL

http://hostname:port/repository/generic
/performRQLQuery/performRQLQuery

Web Service Class Name

webservice.PerformRQLQuerySEIImpl

Nucleus Component

/atg/repository/RepositoryServices

Method Name

performRqlQuery

Input Parameters

String pRepositoryPath
The path of the repository component to query against.

String pItemDescriptorName
The item type of the repository items to query against.

String pRQLString
The RQL string to execute. Note that this string cannot contain parameters.

Output

String[]
The found RepositoryItems in XML format, or null if no items satisfy the given query.

Exceptions

atg.repository.RepositoryException if a repository error occurs

atg.repository.xml.GetException if an error occurs translating the item into XML

PerformRQLQuery Exceptions

Exceptions generated by the PerformRQLQuery Web service may occur for the following reasons:

RepositoryException

GetException

Web Service Generation

The following parameters are used to generate this Web service, using the WebServiceGeneratorImpl class:

Parameter

Value

NucleusPath

/atg/repository/RepositoryServices

MethodName

performRQLQuery

EarFileName

repositoryWebServices.ear

AppName

RepositoryWebServices

AppDescription

A collection of Web services used to make repository calls

ServletName

performRQLQuery

ServletDisplayName

PerformRQLQuery

ServletDescription

When called, executes the given query against the specified repository

URLPattern

PerformRQLQuery

WebURI

generic.war

ContextPath

repository/generic

WebAppDisplayName

RepositoryServices

WebAppDescription

A collection of generic repository Web services, where the user must provide information about which repository is being acted upon

Host

null (will be dynamic)

Port

null (will be dynamic)

ParameterNames

pRepositoryPath, pItemDescriptorName, pRQLString

UseSession

true

 
loading table of contents...