collectParameterValues(objectPath, parameterValues, options)

Use this method to collect values for all parameters that must be specified before the report can run.

The values are stored in the parameters property An instance of this class is returned in the details property when the request is complete.

If the request first generates a prompt page, the page is stored in an instance of bibus » asynchDetailReportOutput which is returned in the details property.

This method may return the following values in the status property:

You may make secondary requests after using this method, depending on the server response. For more information about the asynchronous conversation status and secondary requests in asynchronous conversations, see Secondary requests.

Use of this method requires:

  • traverse permission for all ancestors of the object

  • execute permission for the object

  • read or execute permission for the metadata

Signatures

Java and Apache Axis
 
public  com.cognos.developer.schemas.bibus._3.AsynchReply 
collectParameterValues( 
com.cognos.developer.schemas.bibus._3.SearchPathSingleObject 
objectPath,  com.cognos.developer.schemas.bibus._3.ParameterValue[] 
parameterValues,  com.cognos.developer.schemas.bibus._3.Option[] 
options) 
C# .NET
 
public  asynchReply  collectParameterValues(searchPathSingleObject 
objectPath,  parameterValue[]  parameterValues,  option[]  options) 

References

Part of the following method sets:
Implemented by the following services:

The services that implement the collectParameterValues method, along with the associated SOAP actions, are listed in the following table.

Table 1. Services implementing the collectParameterValues method.

Service

SOAP Action
batchReportService

http://www.ibm.com/xmlns/prod/cognos/batchReportService/201404/
powerPlayService

http://www.ibm.com/xmlns/prod/cognos/powerPlayService/201404/
reportService

http://www.ibm.com/xmlns/prod/cognos/reportService/201404/

batchReportService and reportService information

This information is specific to the batchReportService and reportService services.

New in Version 10.1.0 — New PowerPlay Service Methods

This method was added. It replaces the report » collectParameterValues(objectPath, parameterValues, options) – obsolete method.

powerPlayService information

This information is specific to the powerPlayService service.

New in Version 10.1.0 — New PowerPlay Service Methods

The documentation has been updated to show that this service now supports this method.

What's new

New in Version 10.1.0 — New PowerPlay Service Methods

This method was added.

Input parameters

Use the following parameters when calling this method.

objectPath

Specifies the object associated with the request.

This argument

parameterValues

Specifies the parameter values for the request.

Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

options

Specifies the options for the request.

Options can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

  • is an array of type bibus » option

    is encoded as type tns:optionArray

Return values

This method returns the following values.

result

Returns the state of the asynchronous conversation. Possible asynchronous conversation states are defined in the bibus » asynchReplyStatusEnum enumeration set.

Any data requested can be obtained by examining the bibus » asynchReply » details property.

This result