org.kuali.kfs.gl.batch.service.impl
Class DocumentGroupData

java.lang.Object
  org.kuali.kfs.gl.batch.service.impl.DocumentGroupData

public class DocumentGroupData
extends Object

This class represents document group-related data

Field Summary

protected String	documentNumber
protected String	financialDocumentTypeCode
protected String	financialSystemOriginationCode

Constructor Summary

DocumentGroupData(String documentNumber, String financialDocumentTypeCode, String financialSystemOriginationCode)

DocumentGroupData(Transaction entry)

Method Summary

boolean	equals(Object obj) Returns true if DocumentGroupData objects have the same document number, document type code, and financial system origination code
static <E extends Transaction> Set<DocumentGroupData>	getDocumentGroupDatasForTransactions(Iterator<E> transactions) Given an iterator of Transaction objects, return a set of all the document groups (doc #, doc type, origination code) for these transactions
String	getDocumentNumber() Gets the documentNumber attribute.
String	getFinancialDocumentTypeCode() Gets the financialDocumentTypeCode attribute.
String	getFinancialSystemOriginationCode() Gets the financialSystemOriginationCode attribute.
int	hashCode()
boolean	matchesCollectorDetail(CollectorDetail detail)
boolean	matchesTransaction(Transaction transaction) Returns true if this document group data object's and the transaction have the same document number, document type code, and origination code match the passed
OriginEntryFull	populateDocumentGroupDataFieldsInOriginEntry() This returns an origin entry with document number, document type code, origination code set from this DocumentGroupData's document number, document type code, and origination code
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute value.
void	setFinancialDocumentTypeCode(String financialDocumentTypeCode) Sets the financialDocumentTypeCode attribute value.
void	setFinancialSystemOriginationCode(String financialSystemOriginationCode) Sets the financialSystemOriginationCode attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

documentNumber

protected String documentNumber

financialDocumentTypeCode

protected String financialDocumentTypeCode

financialSystemOriginationCode

protected String financialSystemOriginationCode

Constructor Detail

DocumentGroupData

public DocumentGroupData(Transaction entry)

DocumentGroupData

public DocumentGroupData(String documentNumber,
                         String financialDocumentTypeCode,
                         String financialSystemOriginationCode)

Method Detail

equals

public boolean equals(Object obj)

Returns true if DocumentGroupData objects have the same document number, document type code, and financial system origination code

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

matchesTransaction

public boolean matchesTransaction(Transaction transaction)

Returns true if this document group data object's and the transaction have the same document number, document type code, and origination code match the passed

Parameters:

transaction - transaction to compare

Returns:

true if this document group data object's and the transaction have the same document number, document type code, and origination code match the passed

matchesCollectorDetail

public boolean matchesCollectorDetail(CollectorDetail detail)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

populateDocumentGroupDataFieldsInOriginEntry

public OriginEntryFull populateDocumentGroupDataFieldsInOriginEntry()

This returns an origin entry with document number, document type code, origination code set from this DocumentGroupData's document number, document type code, and origination code

Returns:

populated origin entry

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Returns:

Returns the documentNumber.

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute value.

Parameters:

documentNumber - The documentNumber to set.

getFinancialDocumentTypeCode

public String getFinancialDocumentTypeCode()

Gets the financialDocumentTypeCode attribute.

Returns:

Returns the financialDocumentTypeCode.

setFinancialDocumentTypeCode

public void setFinancialDocumentTypeCode(String financialDocumentTypeCode)

Sets the financialDocumentTypeCode attribute value.

Parameters:

financialDocumentTypeCode - The financialDocumentTypeCode to set.

getFinancialSystemOriginationCode

public String getFinancialSystemOriginationCode()

Gets the financialSystemOriginationCode attribute.

Returns:

Returns the financialSystemOriginationCode.

setFinancialSystemOriginationCode

public void setFinancialSystemOriginationCode(String financialSystemOriginationCode)

Sets the financialSystemOriginationCode attribute value.

Parameters:

financialSystemOriginationCode - The financialSystemOriginationCode to set.

getDocumentGroupDatasForTransactions

public static <E extends Transaction> Set<DocumentGroupData> getDocumentGroupDatasForTransactions(Iterator<E> transactions)

Given an iterator of Transaction objects, return a set of all the document groups (doc #, doc type, origination code) for these transactions

Parameters:

transactions - iterator of transactions

Returns:

Set of all of the document groups for this these trasnactions