org.kuali.kfs.pdp.service
Interface PaymentMaintenanceService

All Known Implementing Classes:

PaymentMaintenanceServiceImpl

public interface PaymentMaintenanceService

This class has methods for payment maintenance.

Method Summary

boolean	cancelDisbursement(Integer paymentGroupId, Integer paymentDetailId, String note, org.kuali.rice.kim.bo.Person user) This method cancels all disbursements with the same disbursment number as that of the given payment id if the following rules apply.
boolean	cancelPendingPayment(Integer paymentGroupId, Integer paymentDetailId, String note, org.kuali.rice.kim.bo.Person user) This method cancels the pending payment of the given payment id if the following rules apply.
boolean	cancelReissueDisbursement(Integer paymentGroupId, String changeText, org.kuali.rice.kim.bo.Person user) This method cancels and re-opens all disbursements with the same disbursment number as that of the given payment id if the following rules apply.
void	changeImmediateFlag(Integer paymentGroupId, String changeText, org.kuali.rice.kim.bo.Person user) This method changes the immediate flag
boolean	holdPendingPayment(Integer paymentGroupId, String note, org.kuali.rice.kim.bo.Person user) This method holds pending payment of the given payment id if the following rules apply.
boolean	removeHoldPendingPayment(Integer paymentGroupId, String note, org.kuali.rice.kim.bo.Person user) This method removes holds on pending payments of the given payment id if the following rules apply.

Method Detail

cancelPendingPayment

boolean cancelPendingPayment(Integer paymentGroupId,
                             Integer paymentDetailId,
                             String note,
                             org.kuali.rice.kim.bo.Person user)

This method cancels the pending payment of the given payment id if the following rules apply. - Payment status must be: "open", "held", or "pending/ACH".

Parameters:

paymentGroupId - Primary key of the PaymentGroup that the Payment Detail to be canceled belongs to.

paymentDetailId - Primary key of the PaymentDetail that was actually canceled.

note - Change note text entered by user.

user - The user that cancels the payment

Returns:

true if cancel payment succesful, false otherwise

holdPendingPayment

boolean holdPendingPayment(Integer paymentGroupId,
                           String note,
                           org.kuali.rice.kim.bo.Person user)

This method holds pending payment of the given payment id if the following rules apply. - Payment status must be: "open".

Parameters:

paymentGroupId - Primary key of the PaymentGroup that the Payment Detail to be held belongs to.

note - Change note text entered by user.

user - The user that holds the payment

removeHoldPendingPayment

boolean removeHoldPendingPayment(Integer paymentGroupId,
                                 String note,
                                 org.kuali.rice.kim.bo.Person user)

This method removes holds on pending payments of the given payment id if the following rules apply. - Payment status must be: "held".

Parameters:

paymentGroupId - Primary key of the PaymentGroup that the Payment Detail to be un-held belongs to

note - Change note text entered by user.

user - the user that removes hold on payment

cancelDisbursement

boolean cancelDisbursement(Integer paymentGroupId,
                           Integer paymentDetailId,
                           String note,
                           org.kuali.rice.kim.bo.Person user)

This method cancels all disbursements with the same disbursment number as that of the given payment id if the following rules apply. - Payment status must be: "extr".

Parameters:

paymentGroupId - Primary key of the PaymentGroup that the Payment Detail to be cancelled belongs to.

paymentDetailId - Primary key of the PaymentDetail that was actually cancelled.

note - Change note text entered by user.

user - The user that cancels the disbursement

cancelReissueDisbursement

boolean cancelReissueDisbursement(Integer paymentGroupId,
                                  String changeText,
                                  org.kuali.rice.kim.bo.Person user)

This method cancels and re-opens all disbursements with the same disbursment number as that of the given payment id if the following rules apply. - Payment status must be: "extr".

Parameters:

paymentGroupId - Primary key of the PaymentGroup that the Payment Detail to be canceled/reissued belongs to.

changeText - Change note text entered by user.

user - The user that cancels/reissues disbursement

changeImmediateFlag

void changeImmediateFlag(Integer paymentGroupId,
                         String changeText,
                         org.kuali.rice.kim.bo.Person user)

This method changes the immediate flag

Parameters:

paymentGroupId - the payment group id

changeText - the change text

user - the user that changes the immediate flag