com.isti.trinetwatch.emailer

Class SubsetReportBlock

java.lang.Object

com.isti.trinetwatch.emailer.SubsetReportBlock

All Implemented Interfaces:

ReportDataBlock, java.lang.Comparable

public class SubsetReportBlock
extends java.lang.Object
implements ReportDataBlock

Class SubsetReportBlock contains the data items necessary for a report item on a subset change event.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	noneStr
java.lang.String	statusLevelName
java.lang.String	subsetName
long	timeVal

Constructor Summary

Constructors

Constructor and Description
SubsetReportBlock(java.lang.String subsetName, StatusLevelTag newSLevelTag, long timeVal) Creates a data block of items necessary for a report on a subset change event.
SubsetReportBlock(java.lang.String subsetName, java.lang.String statusLevelName, long timeVal) Creates a data block of items necessary for a report on a subset change event.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object cmpObj) Compares this object with the given object for order.
java.lang.String	getDetailDisplayString(boolean shortFlag, java.lang.String indentStr) Returns a report-format display string of the "detail" items in this data block.
java.lang.String	getDisplayString(boolean showTimeFlag) Returns a report-format display string of the items in this data block.
java.lang.String	getDisplayString(boolean showTimeFlag, boolean noNameFlag) Returns a report-format display string of the items in this data block.
java.lang.String	getName() Returns the subset name.
java.lang.String	getShortDisplayString() Returns a short-version report-format display string of the items in this data block.
long	getTimeVal() Returns the time value associated with the data (in seconds since 1/1/1970).

Methods inherited from class java.lang.Object

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

Field Detail

noneStr

public static final java.lang.String noneStr

See Also:

Constant Field Values

subsetName

public final java.lang.String subsetName

statusLevelName

public final java.lang.String statusLevelName

timeVal

public final long timeVal

Constructor Detail

SubsetReportBlock

public SubsetReportBlock(java.lang.String subsetName,
                         java.lang.String statusLevelName,
                         long timeVal)

Creates a data block of items necessary for a report on a subset change event.

Parameters:

subsetName - subset name.

statusLevelName - "old" usage level name.

timeVal - the time value associated with the data (in seconds since 1/1/1970).

SubsetReportBlock

public SubsetReportBlock(java.lang.String subsetName,
                         StatusLevelTag newSLevelTag,
                         long timeVal)

Creates a data block of items necessary for a report on a subset change event.

Parameters:

subsetName - subset name.

newSLevelTag - "old" usage level tag object.

timeVal - the time value associated with the data (in seconds since 1/1/1970).

Method Detail

getName

public java.lang.String getName()

Returns the subset name.

Specified by:

getName in interface ReportDataBlock

Returns:

The subset name.

getTimeVal

public long getTimeVal()

Returns the time value associated with the data (in seconds since 1/1/1970).

Specified by:

getTimeVal in interface ReportDataBlock

Returns:

The time value associated with the data (in seconds since 1/1/1970).

getDisplayString

public java.lang.String getDisplayString(boolean showTimeFlag,
                                         boolean noNameFlag)

Returns a report-format display string of the items in this data block.

Specified by:

getDisplayString in interface ReportDataBlock

Parameters:

showTimeFlag - true to display the time value with the data.

noNameFlag - true to not display the subset name and to put the time value after the data, false to display the subset name and to put the time value before the data.

Returns:

A report-format display string of the items in this data block.

getDisplayString

public java.lang.String getDisplayString(boolean showTimeFlag)

Returns a report-format display string of the items in this data block.

Specified by:

getDisplayString in interface ReportDataBlock

Parameters:

showTimeFlag - true to display the time value after the data.

Returns:

A report-format display string of the items in this data block.

getShortDisplayString

public java.lang.String getShortDisplayString()

Returns a short-version report-format display string of the items in this data block.

Specified by:

getShortDisplayString in interface ReportDataBlock

Returns:

A short-version report-format display string of the items in this data block.

getDetailDisplayString

public java.lang.String getDetailDisplayString(boolean shortFlag,
                                               java.lang.String indentStr)

Returns a report-format display string of the "detail" items in this data block.

Specified by:

getDetailDisplayString in interface ReportDataBlock

Parameters:

shortFlag - if true then a short version of the display string is returned.

indentStr - indentation to use, or null for default indentation.

Returns:

A report-format display string of the items in this data block.

compareTo

public int compareTo(java.lang.Object cmpObj)

Compares this object with the given object for order. The 'subsetName' string is used for the comparison, with the network code prefix (i.e. "CI-") used as a secondary comparison value.

Specified by:

compareTo in interface ReportDataBlock

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

cmpObj - a 'SubsetReportBlock' object to compare to.

Returns:

A negative integer, zero or a positive integer as this object is less than, equal to or greater than the given object.

Throws:

'ClassCastException' - if the given object is not of type 'SubsetReportBlock'.