PerformRQLCountQuery Web Service

The PerformRQLCountQuery Web service executes a given RQL string on the repository specified by the pRepositoryPath argument, and returns the number of items that satisfy that query. The given RQL string cannot contain parameters, as RQL expects parameters in the form of an array of Objects and a Web service request cannot pass an array of Objects. The Web service calls through to the performRQLCountQuery method of the atg.repository.RepositoryServices class, which handles all logic and error checking.

Web Service Implementation

Web Service URL

http://hostname:port/repository/generic
/performRQLCountQuery/performRQLCountQuery

Web Service Class Name

webservice.PerformRQLCountQuerySEIImpl

Nucleus Component

/atg/repository/RepositoryServices

Method Name

performRqlCountQuery

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

int
The number of RepositoryItems that satisfy the given query.

Exception

atg.repository.RepositoryException if a repository error occurs

PerformRQLCountQuery Exceptions

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

RepositoryException

Web Service Generation

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

Parameter

Value

NucleusPath

/atg/repository/RepositoryServices

MethodName

performRQLCountQuery

EarFileName

repositoryWebServices.ear

AppName

RepositoryWebServices

AppDescription

A collection of Web services used to make repository calls

ServletName

performRQLCountQuery

ServletDisplayName

PerformRQLCountQuery

ServletDescription

Performs a repository count query using the given repository path, item descriptor name and RQL string

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