6 Oracle Fusion/ADF Load Module

This chapter provides a complete listing and reference for the methods in the OpenScript AdfLoadService Class of ADF Load Module Application Programming Interface (API).

6.1 AdfLoadService ENUM Reference

The following section provides an alphabetical listing of the enums in the OpenScript AdfLoadService API.

6.1.1 Alphabetical Enum Listing

The following table lists the AdfLoadService Enums in alphabetical order.

Table 6-1 List of AdfLoadService Enums

Enum Description

VariableType

Specifies the tag types of the ADF response content for the solveGroupAdf() method.


6.2 AdfLoadService API Reference

The following section provides an alphabetical listing of the methods in the OpenScript AdfLoadService API.

6.2.1 Alphabetical Command Listing

The following table lists the AdfLoadService API methods in alphabetical order.

Table 6-2 List of AdfLoadService Methods

Method Description

adfload.getAdfVariable

Constructor for an ADF variable.

adfload.solveGroupAdf

Extracts multiple ADF variables from the ADF Rich Response Content and stores them in the variables collection.


The following sections provide detailed reference information for each method and enum in the AdfLoadService Class of ADF Load Module Application Programming Interface.

adfload.getAdfVariable

Constructor for an ADF variable.

Format

The adfload.getAdfVariable method has the following command format(s):

adfload.getAdfVariable(name, xpath, variableValue, segmentIndex, variableIndex, variableType, encodeOption);

Command Parameters

name

a String spcifying the variable name. Must not be null.

xpath

a String specifying the XPath which is used to locate the value of an ADF variable from the last retrieved contents. Must not be null.

variableValue

a String specifying last value of the variable. Must not be null.

segmentIndex

an int specifying the index of the segment in which variable appears. Must not be null.

variableIndex

an int specifying the index of the appearance that matches the XPath in a segment. Must not be null.

variableType

an enum specifying the type of ADF Variable, such as VariableType.RICHCOMPONENT or VariableType.INPUT. Must not be null.

encodeOption

an EncodeOptions enum specifying the encoding or decoding operation to perform on the variable's value after solving the variable. A null value is equivalent to EncodeOptions.None.

Returns

an AdfVariable Object. Must not be null.

Example

Constructor for an ADF variable using properties of an ADF variable.

adfload.getAdfVariable("adf_option_0_9",".//OPTION[@id='opt']/@value", 
 "2",0, 0, VariableType.OPTION, EncodeOptions.None);

adfload.solveGroupAdf

Extracts multiple ADF variables from the ADF Rich Response Content and stores them in the variables collection.

Format

The adfload.solveGroupAdf method has the following command format(s):

adfload.solveGroupAdf(adfVariables);

Command Parameters

adfVariables

one or more AdfVariable objects representing multiple ADF variables. Must not be null.

Throws

AbstractScriptException

represents an exception that may be thrown during the execution of adfload script.

Example

Extracts two ADF variables from the ADF Rich Response Content and stores them in the variables collection.

adfload.solveGroupAdf(adfload.getAdfVariable("adf_comp_ptemppt_soc1",
     "//AdfRichSelectOneChoice[@immediate='true']" +
     "/@fullId","ptemp:pt_soc1", -1, -1, VariableType.RICHCOMPONENT,
         EncodeOptions.None),
    adfload.getAdfVariable("adf_option_0_9", ".//OPTION[@id='opt']" +
     "/@value", "2",0, 0, VariableType.OPTION, EncodeOptions.None));

VariableType

The VariableType has the following values:

Table 6-3 List of VariableType Values

Value Description

LINK

LINK tag.

FORMACTION

FORMACTION tag.

FRAMESRC

FRAMESRC tag.

INPUT

INPUT tag.

TEXTAREA

TEXTAREA tag.

OPTION

OPTION tag.

RICHCOMPONENT

RICHCOMPONENT tag.