Class BrowserAction

Extends CompositionItem.

Class Summary
Constructor Attributes	Constructor Name and Description
	BrowserAction() Represents a BrowserAction within the Composition.

Field Summary
Field Attributes	Field Name and Description
{boolean}	hasValidationFailures True if this Browser Action had any validation failures.
<constant> {integer}	REQUEST_OPERATION_PARAMS A constant that can be passed in calls to the "getRequest" and "setRequest" methods.
<constant> {integer}	RESPONSE_OUTPUTS A constant that can be passed in calls to the "getResponse" method.
{Target}	target The Target object for this Browser Action.
{String}	type The value "Browser Action".

Method Summary
Method Attributes	Method Name and Description
	clearResponse() Clears any current response from memory.
{String[]}	getRequest(responseFieldIndicator) Returns the "parameter" values for the Browser Action.
{Object}	getResponse(responseFieldIndicator) Returns a JavaScript associative array containing the "output" values from the Browser Action.
	setRequest(value, responseFieldIndicator) Sets the "parameter" values for the Browser Action.

Methods borrowed from class CompositionItem:: clearRepeat, end, endRepeat, getChild, getItemViaPath, setRepeat

Class Detail

BrowserAction()

Represents a BrowserAction within the Composition.

Field Detail

{boolean} hasValidationFailures

True if this Browser Action had any validation failures.

False until the Browser Action plays. If the Browser Action never plays, remains false.

Read only.

Since:: Build 5618

<constant> {integer} REQUEST_OPERATION_PARAMS

A constant that can be passed in calls to the "getRequest" and "setRequest" methods. (See the descriptions of the "getRequest" and "setRequest" methods.)

Read only.

<constant> {integer} RESPONSE_OUTPUTS

A constant that can be passed in calls to the "getResponse" method. (See the descriptions of the "getResponse" method.)

Read only.

{Target} target

The Target object for this Browser Action. Can be null.

Read only.

{String} type

The value "Browser Action". Read only.

Method Detail

clearResponse()

Clears any current response from memory.

Can be used after the Browser Action plays to free up the memory used to hold the response if the Browser Action does not have scope "private".

If the Browser Action has scope private, this call is not necessary, since the memory will be freed automatically by the system when it goes out of scope.

{String[]} getRequest(responseFieldIndicator)

Returns the "parameter" values for the Browser Action. An array of up to four String values is returned. The array will always have a size of four elements. If the Browser Action has less than four parameters, the extra elements of the returned array will contain nulls.

Parameters:
{integer} responseFieldIndicator: The only "indicator" value currently supported is the "REQUEST_OPERATION_PARAMS" property value.

Returns:: {String[]}
Array of parameter values.

{Object} getResponse(responseFieldIndicator)

Returns a JavaScript associative array containing the "output" values from the Browser Action. The "keys" of the array are the names of the output values, and the values associated with the "keys" are the output values themselves.

If the Browser Action did not return any "output" values, null is returned.

Parameters:
{integer} responseFieldIndicator: The only "indicator" value currently supported is the "RESPONSE_OUTPUTS" property value.

Returns:: {Object}
The "output" values from the Browser Action.

setRequest(value, responseFieldIndicator)

Sets the "parameter" values for the Browser Action.

Parameters:
{integer} value: An array of up to four String values, representing up to four "parameter" values to be placed into the request. Any and all existing parameters in the request will be removed and replaced with these new values.
{integer} responseFieldIndicator: The only "indicator" value currently supported is the "REQUEST_OPERATION_PARAMS" property value.

Classes

Class BrowserAction