ConditionService Service

Use the ConditionService service to evaluate Oracle Analytics conditions programatically. This service also allows users to obtain the customizable filters available in a condition.

Method Name	Description
evaluateCondition() Method	Evaluates a condition saved to the catalog.
evaluateInlineCondition() Method	Evaluate a condition supplied as a parameter.
getConditionCustomizableReportElements() Method	Obtains the customizable filters of a condition saved to the catalog.

evaluateCondition() Method

Use the evaluateCondition() method to evaluate a Condition that is stored in the catalog. This method returns an XML string containing the result of the condition (true or false).

Signature

boolean evaluateCondition(String path, String[] reportCustomizationParameters, String sessionID);

Arguments	Description
String path	Specifies the full path and name of the Condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget.
String [] reportCustomizationParameters	Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Arguments

Description

String path

Specifies the full path and name of the Condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget.

String [] reportCustomizationParameters

Specifies the customization parameters XML, which is only used if the Condition has customizable filters.

This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

evaluateInlineCondition() Method

Use the evaluateInlineCondition() method to evaluate a condition defined outside of Oracle Analytics. The Condition XML is supplied in the conditionXML parameter. This method returns an XML string with the result of the condition evaluation, true or false.

Signature

boolean evaluateInlineCondition(String conditionXML, String[] reportCustomizationParameters, String sessionID);

Arguments	Description
String conditionXML	Specifies the Condition XML. This XML is validated against the condition schema available in orahome/bifoundation/web/schemas/condition.xsd.
String[] ListreportCustomizationParameters	Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Arguments

Description

String conditionXML

Specifies the Condition XML.

This XML is validated against the condition schema available in orahome/bifoundation/web/schemas/condition.xsd.

String[] ListreportCustomizationParameters

Specifies the customization parameters XML, which is only used if the Condition has customizable filters.

This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

getConditionCustomizableReportElements() Method

Use the getConditionCustomizableReportElements() method to determine the customizable filters available in a condition that is stored in the catalog.

This method returns an XML string containing the definition of the customizable filters available in the condition.

The XML is in the format defined in the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

Signature

String[] getConditionCustomizableReportElements(String path, String sessionID);

Arguments	Description
String path	Specifies the full path and name of the condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.