com.screenscraper.events.session

Class SessionEventData

java.lang.Object

java.util.EventObject

com.screenscraper.events.AbstractEventData

com.screenscraper.events.session.SessionEventData

All Implemented Interfaces:

java.io.Serializable

public class SessionEventData
extends AbstractEventData

Event data for session 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
SessionEventData(ScrapingSession session, java.lang.String variableName, java.lang.Object variableValue, java.lang.Object incrementRecordsAmount, boolean increment)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getIncrementRecordsAmount() Returns the increment records amount (if the event time deals with records count modifications, null otherwise)
ScrapingSession	getSession() Returns the current scraping session on which the event was triggered
java.lang.String	getVariableName() Returns the name of the variable being manipulated (if the event time deals with variable manipulation, null otherwise)
java.lang.Object	getVariableValue() Returns the value of the variable being manipulated (if the event time deals with variable manipulation, null otherwise).
boolean	isIncrement() Returns whether or not the record modification number is an increment (true) or is simply setting the value to a new value (false)
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

SessionEventData

SessionEventData(@NotNull
                 ScrapingSession session,
                 @Nullable
                 java.lang.String variableName,
                 @Nullable
                 java.lang.Object variableValue,
                 @Nullable
                 java.lang.Object incrementRecordsAmount,
                 boolean increment)

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

getVariableName

@Nullable
public java.lang.String getVariableName()

Returns the name of the variable being manipulated (if the event time deals with variable manipulation, null otherwise)

Returns:

The name of the variable being manipulated (if the event time deals with variable manipulation, null otherwise)

getVariableValue

@Nullable
public java.lang.Object getVariableValue()

Returns the value of the variable being manipulated (if the event time deals with variable manipulation, null otherwise). Note that the value can be null on a manipulation call, if the value of the variable was null

Returns:

The value of the variable being manipulated (if the event time deals with variable manipulation, null otherwise). Note that the value can be null on a manipulation call, if the value of the variable was null

getIncrementRecordsAmount

@Nullable
public java.lang.Object getIncrementRecordsAmount()

Returns the increment records amount (if the event time deals with records count modifications, null otherwise)

Returns:

The increment records amount (if the event time deals with records count modifications, null otherwise)

isIncrement

public boolean isIncrement()

Returns whether or not the record modification number is an increment (true) or is simply setting the value to a new value (false)

Returns:

Whether or not the record modification number is an increment (true) or is simply setting the value to a new value (false)

Since:

7.0.1a

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.util.EventObject