Package com.inductiveautomation.ignition.common.alarming.evaluation

Class ShelvedPath

java.lang.Object

com.inductiveautomation.ignition.common.alarming.evaluation.ShelvedPath

All Implemented Interfaces:

java.io.Serializable

public class ShelvedPath
extends java.lang.Object
implements java.io.Serializable

This class provides information about a path that has been "shelved", such as when it was shelved, and by whom, and the actual path.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShelvedPath(Path path, QualifiedPath user, long expiration)
ShelvedPath(Path path, QualifiedPath user, long expiration, java.util.Date shelveTime)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getExpiration()
int	getHitCount()
Path	getPath()
java.util.Date	getShelveTime()
QualifiedPath	getUser()
void	incrementHitCount()
boolean	isExpired()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShelvedPath

public ShelvedPath(Path path,
                   QualifiedPath user,
                   long expiration)

ShelvedPath

public ShelvedPath(Path path,
                   QualifiedPath user,
                   long expiration,
                   java.util.Date shelveTime)

Method Detail

getPath

public Path getPath()

getUser

public QualifiedPath getUser()

getShelveTime

public java.util.Date getShelveTime()

getExpiration

public java.util.Date getExpiration()

getHitCount

public int getHitCount()

incrementHitCount

public void incrementHitCount()

isExpired

public boolean isExpired()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object