com.screenscraper.util.internal.services.depthtracker

Class Category

java.lang.Object

com.screenscraper.util.internal.services.depthtracker.Category

All Implemented Interfaces:

java.lang.Comparable<Category>

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

Represents a Category in the depth tracking

Version:

1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(Category other)
boolean	equals(java.lang.Object o)
java.util.List<Category>	getChildren() Returns a list of categories that are direct children of this category
int	getDepth() Returns the depth of this category in the site tree.
java.util.Date	getFirstEntered() Returns the first time a thread entered this category
long	getId() Returns the ID of the category
java.util.Date	getLastEntry() Returns the last time this category was entered.
java.util.Date	getLastSuccessfulEntryAndExit() Returns the last time this category was entered and exited successfully.
java.util.Date	getLastSuccessfulExit() Returns the last time this category was exited successfully.
java.util.Date	getLastUpdated() Returns the last time this category was updated
java.lang.String	getName() Returns the name of this category
java.lang.Long	getParentId() Returns the id of the parent category, or null if this category has no parent
java.util.Date	getPreviousLastEntry() Returns the last time this category was entered prior to the most recent entry.
java.util.Date	getPreviousLastSuccessfulExit() Returns the last time this category was exited successfully prior to the most recent successful exit.
int	getRecords() Returns the number of records found in this category
Site	getSite() Returns the site this category is part of
long	getSiteId() Returns the id of the site
RunState	getStatus() Returns the current status of this category
int	getThreadCount() Returns the number of threads in this category.
java.util.Collection<ExecutionThread>	getThreads() Returns a list of threads that are currently running in this category
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Category

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

Method Detail

getLastEntry

@Nullable
public java.util.Date getLastEntry()

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

Returns:

The last time this category was entered. If the category 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 category was entered prior to the most recent entry. If the category 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 category was entered prior to the most recent entry. If the category 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 category was exited successfully.

Returns:

The last time this category was exited successfully.

getPreviousLastSuccessfulExit

@Nullable
public java.util.Date getPreviousLastSuccessfulExit()

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

Returns:

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

getLastSuccessfulEntryAndExit

@Nullable
public java.util.Date getLastSuccessfulEntryAndExit()

Returns the last time this category 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 category was entered and exited successfully. This value is set by clients and so may not always be correct if they set it incorrectly

getChildren

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

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

Returns:

A list of categories that are direct children of this category

getThreads

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

Returns a list of threads that are currently running in this category

Returns:

A list of threads that are currently running in this category

getFirstEntered

public java.util.Date getFirstEntered()

Returns the first time a thread entered this category

Returns:

The first time a thread entered this category

getLastUpdated

public java.util.Date getLastUpdated()

Returns the last time this category was updated

Returns:

The last time this category was updated

getId

public long getId()

Returns the ID of the category

Returns:

The id of the category

getParentId

@Nullable
public java.lang.Long getParentId()

Returns the id of the parent category, or null if this category has no parent

Returns:

The id of the parent category, or null if this category has no parent

getName

public java.lang.String getName()

Returns the name of this category

Returns:

The name of this category

getDepth

public int getDepth()

Returns the depth of this category in the site tree. This is 0 based, so 0 is a top-level category

Returns:

The depth of this category in the site tree. This is 0 based, so 0 is a top-level category

getStatus

public RunState getStatus()

Returns the current status of this category

Returns:

The current status of this category

getThreadCount

public int getThreadCount()

Returns the number of threads in this category. This is approximate and may not exactly reflect the actual threads if listed

Returns:

The number of threads in this category. This is approximate and may not exactly reflect the actual threads if listed

getRecords

public int getRecords()

Returns the number of records found in this category

Returns:

The number of records found in this category

getSite

@Nullable
public Site getSite()

Returns the site this category is part of

Returns:

The site this category is part of

getSiteId

public long getSiteId()

Returns the id of the site

Returns:

The id of the site

compareTo

public int compareTo(Category other)

Specified by:

compareTo in interface java.lang.Comparable<Category>

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