validate(objectPath, parameterValues, options)

Use this method to validate an object that contains a specification.

To control the severity of reported defects, specify a validate option of the bibus » validateOptionValidateSeverity class.

The results are stored in an instance of the bibus » asynchDetailReportValidation class, which is returned in the bibus » asynchReply » details property when the request is complete.

This method may return the following values in the bibus » asynchReply » 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:

execute permission for the object
traverse permission for all ancestors of the object

Signatures

Java and Apache Axis

 
public  com.cognos.developer.schemas.bibus._3.AsynchReply  validate( 
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  validate(searchPathSingleObject  objectPath, 
parameterValue[]  parameterValues,  option[]  options)

References

Part of the following method sets:

validate

Implemented by the following services:

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

Table 1. Services implementing the validate method.
Service	SOAP Action
batchReportService	`http://www.ibm.com/xmlns/prod/cognos/batchReportService/201404/`
dataMovementService	`http://www.ibm.com/xmlns/prod/cognos/dataMovementService/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.

The results of calling this method for a bibus » baseReport object are stored in an instance of the bibus » asynchDetailReportValidation class, which is returned in the bibus » asynchReply » details property when the request is complete.

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

The following capability rules are enforced for this method.

The capability rules, along with the associated specifications and classes, are listed in the follwing table.

Table 2. Capability rules for the validate method.
Capabilities	Class
bibus » userCapabilityEnum » canUseAnalysisStudio	bibus » analysis
bibus » userCapabilityEnum » canUseEventStudio	bibus » report
bibus » userCapabilityEnum » canUseQueryStudio	bibus » query
bibus » userCapabilityEnum » canUseReportStudio	bibus » interactiveReport,bibus » report, orbibus » reportTemplate

To use this method, all conditions specified by any row must be satisfied:

The object must be a member of one of the specified classes.If a class is not specified, then the class of the object is not used to determine whether the user can execute the method.
The user must have all specified capabilities.

New in Version 10.1.0 — IBM Cognos Active Report

This method can now be used with a bibus » interactiveReport.

The capability rules were updated to include the rules related to the use of the bibus » interactiveReport class.

dataMovementService information

This information is specific to the dataMovementService service.

The following capability rules are enforced for this method.

The capability rules, along with the associated specifications and classes, are listed in the follwing table.

Table 3. Capability rules for the validate method.
Capabilities	Class
bibus » userCapabilityEnum » canUseDataManager	bibus » dataMovementTask

To use this method, all conditions specified by any row must be satisfied:

The object must be a member of one of the specified classes.If a class is not specified, then the class of the object is not used to determine whether the user can execute the method.
The user must have all specified capabilities.

deliveryService information

This information is specific to the deliveryService service.

powerPlayService information

This information is specific to the powerPlayService service.

The following capability rules are enforced for this method.

The capability rules, along with the associated specifications and classes, are listed in the follwing table.

Table 4. Capability rules for the validate method.
Capabilities	Class
bibus » userCapabilityEnum » canUsePowerPlay	bibus » powerPlayServiceReportSpecification

To use this method, all conditions specified by any row must be satisfied:

The object must be a member of one of the specified classes.If a class is not specified, then the class of the object is not used to determine whether the user can execute the method.
The user must have all specified capabilities.

New in Version 10.1.0 — New PowerPlay Service Methods: The documentation has been updated to indicate that this service now supports this method.

Input parameters

Use the following parameters when calling this method.

objectPath

Specifies the object associated with the request.

This argument

is of type bibus » searchPathSingleObject

is encoded as type tns:searchPathSingleObject

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

is an array of type bibus » parameterValue

is encoded as type tns:parameterValueArray

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

is of type bibus » asynchReply

is encoded as type tns:asynchReply