com.screenscraper.events.script

Class ScriptEventData

java.lang.Object

java.util.EventObject

com.screenscraper.events.AbstractEventData

com.screenscraper.events.script.ScriptEventData

All Implemented Interfaces:

java.io.Serializable

public class ScriptEventData
extends AbstractEventData

Data for script events

Version:

6.0.55a

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ScriptEventData(ScrapingSession session, ScrapeableFile scrapeableFile, java.lang.String scriptName, DataSet dataSet, DataRecord dataRecord, java.lang.Exception scriptException)

Method Summary

Modifier and Type	Method and Description
DataRecord	getDataRecord() Returns the current data record (if applicable to the script) or null otherwise
DataSet	getDataSet() Returns the current data set (if applicable to the script) or null otherwise
ScrapeableFile	getScrapeableFile() Returns the scrapeable file the script is run under (if applicable, null otherwise)
java.lang.Exception	getScriptException() Returns the exception thrown by the script if the event time deals with an exception, null otherwise
java.lang.String	getScriptName() Returns the name of the script the event pertains to
ScrapingSession	getSession() Returns the current scraping session on which the event was triggered
java.lang.String	toString()

Methods inherited from class com.screenscraper.events.AbstractEventData

getLastReturnValue, setLastReturnValue

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptEventData

ScriptEventData(@NotNull
                ScrapingSession session,
                @Nullable
                ScrapeableFile scrapeableFile,
                @NotNull
                java.lang.String scriptName,
                @Nullable
                DataSet dataSet,
                @Nullable
                DataRecord dataRecord,
                @Nullable
                java.lang.Exception scriptException)

Method Detail

getSession

@NotNull
public ScrapingSession getSession()

Returns the current scraping session on which the event was triggered

Returns:

The current scraping session on which the event was triggered

getScrapeableFile

@Nullable
public ScrapeableFile getScrapeableFile()

Returns the scrapeable file the script is run under (if applicable, null otherwise)

Returns:

The scrapeable file the script is run under (if applicable, null otherwise)

getScriptName

@NotNull
public java.lang.String getScriptName()

Returns the name of the script the event pertains to

Returns:

The name of the script the event pertains to

getDataSet

@Nullable
public DataSet getDataSet()

Returns the current data set (if applicable to the script) or null otherwise

Returns:

The current data set (if applicable to the script) or null otherwise

getDataRecord

@Nullable
public DataRecord getDataRecord()

Returns the current data record (if applicable to the script) or null otherwise

Returns:

The current data record (if applicable to the script) or null otherwise

getScriptException

@Nullable
public java.lang.Exception getScriptException()

Returns the exception thrown by the script if the event time deals with an exception, null otherwise

Returns:

The exception thrown by the script if the event time deals with an exception, null otherwise

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.util.EventObject