com.sabratec.applinx.baseobject

Class GXPathResponse

java.lang.Object

com.sabratec.applinx.baseobject.GXPathResponse

All Implemented Interfaces:

Externalizable, Serializable

public class GXPathResponse
extends Object
implements Externalizable

This class is returned from GXIBaseObject.executePath() method. It contains all the contents of the response of the path.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXPathResponse()
GXPathResponse(GXIScreen[] screens, GXVariables variables) Create a new path response

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPathExecutionLog()
GXIScreenCollection	getScreens()
String	getVariable(String varName)
String[]	getVariableArray(String varName)
String	getVariableAt(String varName, int index)
int	getVariableCount(String varName)
String[]	getVariableNames()
boolean	isVariableArray(String varName)
void	readExternal(ObjectInput in)
void	setPathExecutionLog(String pathExecutionLog) Set the execution log of the path.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GXPathResponse

public GXPathResponse(GXIScreen[] screens,
                      GXVariables variables)

Create a new path response

Parameters:

screens - the path collected screens

variables - the path returned variables

GXPathResponse

public GXPathResponse()

Method Detail

getScreens

public GXIScreenCollection getScreens()

Returns:

the screen collection that was gathered during path execution.

getVariable

public String getVariable(String varName)

Parameters:

varName - the name of the variable.

Returns:

the value of the variable as was set during path execution.

isVariableArray

public boolean isVariableArray(String varName)

Parameters:

varName - the name of the variable.

Returns:

true if there is a variable array with the input name in the response.

getVariableNames

public String[] getVariableNames()

Returns:

an array of the names of all the variables in the response.

getVariableArray

public String[] getVariableArray(String varName)

Parameters:

varName - the name of the variable array.

Returns:

an array of values set to the variable during path execution.

getVariableAt

public String getVariableAt(String varName,
                            int index)

Parameters:

varName - the name of the variable array.

index - the index in the array.

Returns:

one of the values from a variable array, according to index.

getVariableCount

public int getVariableCount(String varName)

Parameters:

varName - the name of the variable array.

Returns:

the size of a variable array. If no such array exists, -1 is returned. If the variable is not an array, 1 is returned.

getPathExecutionLog

public String getPathExecutionLog()

Returns:

the execution log of the path. might be null.

setPathExecutionLog

public void setPathExecutionLog(String pathExecutionLog)

Set the execution log of the path. This method is for internal use.

Parameters:

pathExecutionLog - the log to set

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException