org.kuali.kfs.gl.report
Class Summary

java.lang.Object
  org.kuali.kfs.gl.report.Summary

All Implemented Interfaces:

Comparable

public class Summary
extends Object
implements Comparable

This class represents a summary amount used in reporst

Field Summary

static int	SELECTED_RECORD_COUNT_SUMMARY_SORT_ORDER
static int	SEQUENCE_RECORDS_WRITTEN_SUMMARY_SORT_ORDER
static int	TOTAL_RECORD_COUNT_SUMMARY_SORT_ORDER This number is used by TransactionReport when sorting the list of Summary objects passed to TransactionReport.generateReport().

Constructor Summary

Summary()

Summary(int sortOrder, String description, Integer count)
Constructs a Summary.java.

Summary(int sortOrder, String description, long count)
Constructs a Summary.java.

Method Summary

static List<Summary>	buildDefualtReportSummary(String destination, int startingOrder) Build a report summary list for labor general ledger posting
static StringBuilder	buildSummaryDescription(String destinationName, String operationType) Build the description of summary with the given information
int	compareTo(Object arg0) Compare this Summary object with another summary object (non-Javadoc)
boolean	equals(Object object) Returns true if the description of this summary object and the passed in summary object are the same
long	getCount()
String	getDescription()
int	getSortOrder()
void	setCount(long count)
void	setDescription(String description)
void	setSortOrder(int sortOrder)
static void	updateReportSummary(List<Summary> reportSummary, String summaryDescription, int count, int order) Update the report summary with the given information
static void	updateReportSummary(List<Summary> reportSummary, String destinationName, String operationType, int count, int order) Update the report summary with the given information

Methods inherited from class java.lang.Object

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

Field Detail

TOTAL_RECORD_COUNT_SUMMARY_SORT_ORDER

public static final int TOTAL_RECORD_COUNT_SUMMARY_SORT_ORDER

This number is used by TransactionReport when sorting the list of Summary objects passed to TransactionReport.generateReport(). Lowest number prints first.

See Also:

Constant Field Values

SELECTED_RECORD_COUNT_SUMMARY_SORT_ORDER

public static final int SELECTED_RECORD_COUNT_SUMMARY_SORT_ORDER

See Also:

Constant Field Values

SEQUENCE_RECORDS_WRITTEN_SUMMARY_SORT_ORDER

public static final int SEQUENCE_RECORDS_WRITTEN_SUMMARY_SORT_ORDER

See Also:

Constant Field Values

Constructor Detail

Summary

public Summary()

Summary

public Summary(int sortOrder,
               String description,
               long count)

Constructs a Summary.java.

Parameters:

sortOrder -

description -

count -

Summary

public Summary(int sortOrder,
               String description,
               Integer count)

Constructs a Summary.java.

Parameters:

sortOrder -

description -

count -

Method Detail

compareTo

public int compareTo(Object arg0)

Compare this Summary object with another summary object (non-Javadoc)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object object)

Returns true if the description of this summary object and the passed in summary object are the same

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

buildDefualtReportSummary

public static List<Summary> buildDefualtReportSummary(String destination,
                                                      int startingOrder)

Build a report summary list for labor general ledger posting

Parameters:

destination - description of summary displayed

startingOrder - order how information is displayed

Returns:

a list of summary objects

updateReportSummary

public static void updateReportSummary(List<Summary> reportSummary,
                                       String destinationName,
                                       String operationType,
                                       int count,
                                       int order)

Update the report summary with the given information

Parameters:

reportSummary - list of summaries

destinationName - description of summary displayed

operationType - description of what action is related to the summary (i.e. insert, updated, deleted)

count - count of how many "objects" are affected

order - order how information is displayed

updateReportSummary

public static void updateReportSummary(List<Summary> reportSummary,
                                       String summaryDescription,
                                       int count,
                                       int order)

Update the report summary with the given information

Parameters:

reportSummary - list of summaries

summaryDescription - description of summary displayed

count - count of how many "objects" are affected

order - order how information is displayed

buildSummaryDescription

public static StringBuilder buildSummaryDescription(String destinationName,
                                                    String operationType)

Build the description of summary with the given information

Parameters:

destinationName - description of summary displayed

operationType - description of what action is related to the summary (i.e. insert, updated, deleted)

Returns:

getCount

public long getCount()

setCount

public void setCount(long count)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getSortOrder

public int getSortOrder()

setSortOrder

public void setSortOrder(int sortOrder)