com.screenscraper.util.internal.services.iterator.model

Class Iteration

java.lang.Object

com.screenscraper.util.internal.services.iterator.model.Iteration

All Implemented Interfaces:

java.lang.Comparable<Iteration>

public final class Iteration
extends java.lang.Object
implements java.lang.Comparable<Iteration>

Represents a single set of values from an instance

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
Iteration(APIConnection apiConnection, org.jdom.Element element)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Iteration other)
boolean	equals(java.lang.Object o)
java.util.Date	getEnd()
IteratorInstance	getIteratorInstance()
java.util.Date	getLastActivity()
java.util.Date	getLastPing()
java.lang.String	getMessage()
int	getOffset()
int	getPk()
java.lang.Integer	getRecords()
java.lang.String	getRunLocation()
java.util.Date	getStart()
java.util.Map<java.lang.String,java.lang.Object>	getValues()
int	hashCode()
boolean	isCurrentlyRunning()
void	ping(java.lang.Long timeSinceLastActivity)
void	reportCompletion(java.lang.String message, int records)
void	reportError(java.lang.String errorMessage, int recordCount)
void	reportError(java.lang.String errorMessage, int recordCount, boolean rerunImmediately)
void	rerun(long iterationPk)
(package private) void	setIteratorInstance(IteratorInstance instance)
boolean	wasError()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Iteration

Iteration(APIConnection apiConnection,
          @NotNull
          org.jdom.Element element)

Method Detail

getPk

public int getPk()

getIteratorInstance

@Nullable
public IteratorInstance getIteratorInstance()

setIteratorInstance

void setIteratorInstance(IteratorInstance instance)

isCurrentlyRunning

public boolean isCurrentlyRunning()

getOffset

public int getOffset()

getStart

public java.util.Date getStart()

getEnd

public java.util.Date getEnd()

getLastPing

@Nullable
public java.util.Date getLastPing()

getLastActivity

@Nullable
public java.util.Date getLastActivity()

getMessage

@Nullable
public java.lang.String getMessage()

getRunLocation

@Nullable
public java.lang.String getRunLocation()

getRecords

public java.lang.Integer getRecords()

wasError

public boolean wasError()

getValues

public java.util.Map<java.lang.String,java.lang.Object> getValues()

reportCompletion

public void reportCompletion(java.lang.String message,
                             int records)

reportError

public void reportError(java.lang.String errorMessage,
                        int recordCount)

reportError

public void reportError(java.lang.String errorMessage,
                        int recordCount,
                        boolean rerunImmediately)

ping

public void ping(java.lang.Long timeSinceLastActivity)

rerun

public void rerun(long iterationPk)

compareTo

public int compareTo(Iteration other)

Specified by:

compareTo in interface java.lang.Comparable<Iteration>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object