validateSpecification(specification, parameterValues, options)

Use this method to validate a specification.

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

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.

Signatures

Java and Apache Axis
 
public  com.cognos.developer.schemas.bibus._3.AsynchReply 
validateSpecification( 
com.cognos.developer.schemas.bibus._3.AsynchSpecification 
specification,  com.cognos.developer.schemas.bibus._3.ParameterValue[] 
parameterValues,  com.cognos.developer.schemas.bibus._3.Option[] 
options) 
C# .NET
 
public  asynchReply  validateSpecification(asynchSpecification 
specification,  parameterValue[]  parameterValues,  option[]  options) 

References

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

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

Table 1. Services implementing the validateSpecification 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.

For a bibus » baseReport object, 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.

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 Java code snippet demonstrates how to use the report » validateSpecification(specification, parameterValues, options) – obsolete method with the report service.

To see this code in context, view the Java sample ReportAdd/AddReport.java. For more information about the samples, see Code samples and language-specific coding practices.

 
asynchReply  = 
	connection.getReportService().validateSpecification( 
		reportSpec, 
		new  ParameterValue[]  {}, 
		new  Option[]  {}); 
... 
for  (int  i  =  0;  i  <  asynchReply.getDetails().length;  i++) 
{ 
	if  (asynchReply.getDetails()[i]  instanceof  AsynchDetailReportValidation) 
	{ 
		ValidationDefects  =   
		((AsynchDetailReportValidation)asynchReply.getDetails()[i]).getDefects(); 
	} 
} 
 

The following C# code snippet demonstrates how to use the report » validateSpecification(specification, parameterValues, options) – obsolete method with the report service.

To see this code in context, view the C# sample AddReport/AddReport.cs. For more information about the samples, see Code samples and language-specific coding practices.

 
validationResults  =  cBIRS.validateSpecification( 
		reportSvcSpec,  new  parameterValue[]{},  validateOptions); 
... 
for  (int  i  =  0;  i  <  validationResults.details.Length;  i++) 
{ 
	if  (validationResults.details[i]  is  asynchDetailReportValidation) 
	{ 
		if  (((asynchDetailReportValidation)   
			validationResults.details[i]).defects.Value.Length  >  0  ) 
		{ 
			defects  =   
			((asynchDetailReportValidation)  validationResults.details[i]).defects.Value; 
		} 
	} 
} 
 
 

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 validateSpecification method.
Specification Capabilities Class
Trusted bibus » userCapabilityEnum » canUseAdaptiveAnalytics bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted bibus » userCapabilityEnum » canUseAnalysisStudio bibus » reportServiceAnalysisSpecification,bibus » reportServiceMetadataSpecification, orbibus » reportServiceReportSpecification
bibus » userCapabilityEnum » canUseControllerStudio bibus » reportServiceReportSpecification
Trusted bibus » userCapabilityEnum » canUseEventStudio bibus » reportServiceMetadataSpecification
bibus » userCapabilityEnum » canUseEventStudio bibus » reportServiceReportSpecification
Trusted bibus » userCapabilityEnum » canUseMetricsManagerAdministration bibus » reportServiceMetadataSpecification
Trusted bibus » userCapabilityEnum » canUseMetricStudio bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted bibus » userCapabilityEnum » canUsePlanningContributor bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted bibus » userCapabilityEnum » canUseQueryStudio bibus » reportServiceMetadataSpecification,bibus » reportServiceQuerySpecification, orbibus » reportServiceReportSpecification
bibus » userCapabilityEnum » canUseReportStudio bibus » reportServiceInteractiveReportSpecification,bibus » reportServiceMetadataSpecification, orbibus » reportServiceReportSpecification
bibus » userCapabilityEnum » canUseSpecifications bibus » reportServiceAnalysisSpecification,bibus » reportServiceInteractiveReportSpecification,bibus » reportServiceMetadataSpecification,bibus » reportServiceQuerySpecification, orbibus » reportServiceReportSpecification

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

  • A specification is Trusted if it is digitally signed or was received via the secure dispatcher entry point (http://server_name:9300/p2pd/servlet/dispatch).

  • A specification is Not Trusted if it is not digitally signed and was received via the external dispatcher entry point (http://server_name:9300/p2pd/servlet/dispatch/ext).

  • 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 — i_d15e427953.html#ReleaseNotes_ReleaseNotes_101_10.1.RTM.RTC2513

The capability rules were updated to include the rules related to the use of the bibus » reportServiceReportSpecification class with the userCapabilityEnum » canUseDashboardViewer value user capability.

New in Version 10.1.0 — IBM Cognos Active Report

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

The capability rules were updated to include the rules related to the use of the bibus » reportServiceInteractiveReportSpecification 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 validateSpecification method.
Capabilities Class
bibus » userCapabilityEnum » canUseDataManager bibus » dataMovementServiceSpecification

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.

New in Version 10.1.0 — New PowerPlay Service Methods

Reserved.

Input parameters

Use the following parameters when calling this method.

specification

Defines the specification 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