Package com.facilita.fc.eggPlant

Class EggplantReturnData

java.lang.Object

com.facilita.fc.eggPlant.EggplantReturnData

public class EggplantReturnData
extends java.lang.Object

Represents the data returned by a call to the eggPlant system, as returned by EggplantVirtualUserInterface.execute(String)

Method Summary

Modifier and Type	Method	Description
int	duration()	Get the duration in milliseconds of the call to eggPlant.
java.lang.Object	get(java.lang.String key)	Gets the object in the data returned by the call to eggPlant.
java.lang.String	output()	Gets the text produced by a call to eggPlant.
ScriptResults	result()	Get the result of the call to eggPlant.
java.lang.Object	returnValue()	Get the return value of the call to eggPlant.
boolean	timedOut()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

duration

public int duration()
             throws BadValueException

Get the duration in milliseconds of the call to eggPlant.

Returns:

the duration in milliseconds of the call to eggPlant.

Throws:

BadValueException - eggPlant did not return the duration data

returnValue

public java.lang.Object returnValue()
                             throws BadValueException

Get the return value of the call to eggPlant.

Returns:

the object

Throws:

BadValueException - the bad value exception

output

public java.lang.String output()
                        throws BadValueException

Gets the text produced by a call to eggPlant.

Returns:

the text logged by eggPlant

Throws:

BadValueException - eggPlant did not return any data

timedOut

public boolean timedOut()
                 throws BadValueException

Throws:

BadValueException

result

public ScriptResults result()
                     throws BadValueException

Get the result of the call to eggPlant.

Returns:

The result of the call to eggPlant.

Throws:

BadValueException - eggPlant did not return any data

get

public java.lang.Object get(java.lang.String key)
                     throws BadValueException

Gets the object in the data returned by the call to eggPlant.

Parameters:

key - the name of the object to return

Returns:

the object

Throws:

BadValueException - The key does not exist

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object