com.pega.pegarules.pub.session

Class PassivationMetadata

java.lang.Object

com.pega.pegarules.pub.session.PassivationMetadata

All Implemented Interfaces:

java.io.Serializable

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

A container for metadata about a PassivationRecord that is used during reporting. These values are separated out from the PassivationRecord objects so that reporting can be performed without reading the (potentially large) object data serialized in a full PassivationRecord object. Implementers of CustomPassivationMechanism are free to serialize instances of this class, but must pay careful attention to the serialVersionUID if using Java Serialization.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static int	NEVER_EXPIRE
static long	serialVersionUID
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
PassivationMetadata()
PassivationMetadata(java.lang.String aSystemId, java.lang.String aOperatorId, java.util.Date aCreateDateTime, int aExpirationTimeoutInSeconds, java.lang.String aDescription) Create a new passivation metadata object.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreateDateTime()
java.lang.String	getDescription()
long	getExpirationTime()
long	getExpirationTimeoutInSeconds()
java.lang.String	getOperatorId()
java.lang.String	getSystemId()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

NEVER_EXPIRE

public static final int NEVER_EXPIRE

See Also:

Constant Field Values

Constructor Detail

PassivationMetadata

public PassivationMetadata(java.lang.String aSystemId,
                   java.lang.String aOperatorId,
                   java.util.Date aCreateDateTime,
                   int aExpirationTimeoutInSeconds,
                   java.lang.String aDescription)

Create a new passivation metadata object. Some fields may be null.

Parameters:

aSystemId - The system that owns the associated PassivationRecord.

aOperatorId - The operator id that owns the record.

aCreateDateTime - The time that the record was created.

aExpirationTimeoutInSeconds - The number of seconds the associated record should be kept in a backing store. This time is in seconds and is relative to the creation time.

aDescription - A description of the record.

PassivationMetadata

public PassivationMetadata()

Method Detail

getOperatorId

public java.lang.String getOperatorId()

getCreateDateTime

public java.util.Date getCreateDateTime()

getExpirationTimeoutInSeconds

public long getExpirationTimeoutInSeconds()

getDescription

public java.lang.String getDescription()

getSystemId

public java.lang.String getSystemId()

getExpirationTime

public long getExpirationTime()

Returns:

The time at which the associated record with expire in milliseconds since the epoch.