org.kuali.kfs.pdp.service
Interface PaymentGroupService

All Known Implementing Classes:

PaymentGroupServiceImpl

public interface PaymentGroupService

Method Summary

PaymentGroup	get(Integer id)
List<PaymentGroup>	getAchPaymentsNeedingAdviceNotification() Gets list of ach payments in which an advice notification has not been sent
List	getByBatchId(Integer batchId)
List	getByDisbursementNumber(Integer disbursementNbr)
Iterator	getByDisbursementTypeStatusCode(String disbursementType, String paymentStatusCode) Get all payment groups by a disbursement type code and status code
Iterator	getByProcess(PaymentProcess p) Get all payment groups by Payment Process object
List<Integer>	getDisbursementNumbersByDisbursementType(Integer pid, String disbursementType) Get all payment groups by Payment Process Id/Disbursement Type
List<Integer>	getDisbursementNumbersByDisbursementTypeAndBankCode(Integer pid, String disbursementType, String bankCode) Get all payment groups by Payment Process Id/Disbursement Type for a given bank code
List<String>	getDistinctBankCodesForProcessAndType(Integer pid, String disbursementType) Given a process id and a disbursement type, finds a distinct list of bank codes used by payment groups within that payment process
int	getSortGroupId(PaymentGroup paymentGroup) Gets the sort group id
String	getSortGroupName(int sortGroupId) Gets the sort group name
void	processCancelledGroup(PaymentGroup group, Date processDate) Mark a cancelled group as processed
void	processPaidGroup(PaymentGroup group, Date processDate) Mark a paid group as processed
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets DataDictionaryService
void	setParameterService(org.kuali.rice.kns.service.ParameterService parameterService) Sets the parameter service

Method Detail

getByDisbursementTypeStatusCode

Iterator getByDisbursementTypeStatusCode(String disbursementType,
                                         String paymentStatusCode)

Get all payment groups by a disbursement type code and status code

Parameters:

disbursementType -

paymentStatusCode -

Returns:

getByProcess

Iterator getByProcess(PaymentProcess p)

Get all payment groups by Payment Process object

Parameters:

p -

Returns:

getDisbursementNumbersByDisbursementType

List<Integer> getDisbursementNumbersByDisbursementType(Integer pid,
                                                       String disbursementType)

Get all payment groups by Payment Process Id/Disbursement Type

Parameters:

pid -

disbursementType -

Returns:

getDisbursementNumbersByDisbursementTypeAndBankCode

List<Integer> getDisbursementNumbersByDisbursementTypeAndBankCode(Integer pid,
                                                                  String disbursementType,
                                                                  String bankCode)

Get all payment groups by Payment Process Id/Disbursement Type for a given bank code

Parameters:

pid -

disbursementType -

bankCode -

Returns:

getDistinctBankCodesForProcessAndType

List<String> getDistinctBankCodesForProcessAndType(Integer pid,
                                                   String disbursementType)

Given a process id and a disbursement type, finds a distinct list of bank codes used by payment groups within that payment process

Parameters:

pid - payment process to query payment groups of

disbursementType - the type of disbursements to query

Returns:

a sorted List of bank codes

get

PaymentGroup get(Integer id)

getByBatchId

List getByBatchId(Integer batchId)

getByDisbursementNumber

List getByDisbursementNumber(Integer disbursementNbr)

processPaidGroup

void processPaidGroup(PaymentGroup group,
                      Date processDate)

Mark a paid group as processed

Parameters:

group -

processDate -

processCancelledGroup

void processCancelledGroup(PaymentGroup group,
                           Date processDate)

Mark a cancelled group as processed

Parameters:

group -

processDate -

getSortGroupId

int getSortGroupId(PaymentGroup paymentGroup)

Gets the sort group id

Parameters:

paymentGroup -

Returns:

getSortGroupName

String getSortGroupName(int sortGroupId)

Gets the sort group name

Parameters:

sortGroupId -

Returns:

setParameterService

void setParameterService(org.kuali.rice.kns.service.ParameterService parameterService)

Sets the parameter service

Parameters:

parameterService -

setDataDictionaryService

void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

Sets DataDictionaryService

Parameters:

dataDictionaryService -

getAchPaymentsNeedingAdviceNotification

List<PaymentGroup> getAchPaymentsNeedingAdviceNotification()

Gets list of ach payments in which an advice notification has not been sent

Returns:

List