com.screenscraper.util.internal.services.depthtracker

Class Site

java.lang.Object

com.screenscraper.util.internal.services.depthtracker.Site

All Implemented Interfaces:

java.lang.Comparable<Site>

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

Represents a site that can be run in

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
Site(APIConnection connection, org.json.simple.JSONObject json)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Site other)
boolean	equals(java.lang.Object o)
long	getId() Returns the id of the site
java.util.Date	getLastEntry() Returns the last time this site was entered.
java.util.Date	getLastModified() Returns the last time this site was modified.
java.util.Date	getLastReset() Returns the last time this site was reset
java.util.Date	getLastSuccessfulEntryAndExit() Returns the last time this site was entered and exited successfully.
java.util.Date	getLastSuccessfulExit() Returns the last time this site was exited successfully.
int	getMaxThreadsPerCategory() Returns the maximum number of threads this site will allow in a single category
java.lang.String	getName() Returns the name of this site
java.util.Date	getPreviousLastEntry() Returns the last time this site was entered prior to the most recent entry.
java.util.Date	getPreviousLastSuccessfulExit() Returns the last time this site was exited successfully prior to the most recent successful exit.
int	getRecords() Returns the number of records in this site
int	getReduceMaxThreadsPerCategoryEachLevel() Returns the number of threads this site will reduce the allowed amount in a single category per depth level
java.util.List<Category>	getRootCategories() Returns a list of categories that are direct children of this site
int	getThreadCount() Returns the approximate number of threads in the site
java.util.Collection<ExecutionThread>	getThreads() Returns a list of threads that are current executing in this site
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Site

Site(APIConnection connection,
     @NotNull
     org.json.simple.JSONObject json)

Method Detail

getLastEntry

@Nullable
public java.util.Date getLastEntry()

Returns the last time this site was entered. If the site was returned by entering it successfully, this value will be the time you just entered it

Returns:

The last time this site was entered. If the site was returned by entering it successfully, this value will be the time you just entered it

getPreviousLastEntry

@Nullable
public java.util.Date getPreviousLastEntry()

Returns the last time this site was entered prior to the most recent entry. If the site was returned by entering it successfully, this value will be the time it was entered before you just entered it

Returns:

The last time this site was entered prior to the most recent entry. If the site was returned by entering it successfully, this value will be the time it was entered before you just entered it

getLastSuccessfulExit

@Nullable
public java.util.Date getLastSuccessfulExit()

Returns the last time this site was exited successfully.

Returns:

The last time this site was exited successfully.

getPreviousLastSuccessfulExit

@Nullable
public java.util.Date getPreviousLastSuccessfulExit()

Returns the last time this site was exited successfully prior to the most recent successful exit.

Returns:

The last time this site was exited successfully prior to the most recent successful exit.

getLastSuccessfulEntryAndExit

@Nullable
public java.util.Date getLastSuccessfulEntryAndExit()

Returns the last time this site was entered and exited successfully. This value is set by clients and so may not always be correct if they set it incorrectly

Returns:

The last time this site was entered and exited successfully. This value is set by clients and so may not always be correct if they set it incorrectly

getRootCategories

public java.util.List<Category> getRootCategories()

Returns a list of categories that are direct children of this site

Returns:

A list of categories that are direct children of this site

getThreads

public java.util.Collection<ExecutionThread> getThreads()

Returns a list of threads that are current executing in this site

Returns:

A list of threads that are current executing in this site

getName

public java.lang.String getName()

Returns the name of this site

Returns:

The name of this site

getMaxThreadsPerCategory

public int getMaxThreadsPerCategory()

Returns the maximum number of threads this site will allow in a single category

Returns:

The maximum number of threads this site will allow in a single category

getReduceMaxThreadsPerCategoryEachLevel

public int getReduceMaxThreadsPerCategoryEachLevel()

Returns the number of threads this site will reduce the allowed amount in a single category per depth level

Returns:

The number of threads this site will reduce the allowed amount in a single category per depth level

getLastReset

public java.util.Date getLastReset()

Returns the last time this site was reset

Returns:

The last time this site was reset

getLastModified

public java.util.Date getLastModified()

Returns the last time this site was modified. This includes any category being entered

Returns:

The last time this site was modified. This includes any category being entered

getId

public long getId()

Returns the id of the site

Returns:

The id of the site

getThreadCount

public int getThreadCount()

Returns the approximate number of threads in the site

Returns:

The approximate number of threads in the site

getRecords

public int getRecords()

Returns the number of records in this site

Returns:

The number of records in this site

compareTo

public int compareTo(Site other)

Specified by:

compareTo in interface java.lang.Comparable<Site>

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