org.kuali.kfs.pdp.service.impl
Class BatchMaintenanceServiceImpl

java.lang.Object
  org.kuali.kfs.pdp.service.impl.BatchMaintenanceServiceImpl

All Implemented Interfaces:

BatchMaintenanceService

@Transactional
public class BatchMaintenanceServiceImpl
extends Object
implements BatchMaintenanceService

This class provides methods for Batch maintenance.

Constructor Summary

BatchMaintenanceServiceImpl()

Method Summary

boolean	cancelPendingBatch(Integer paymentBatchId, String note, org.kuali.rice.kim.bo.Person user) cancelPendingBatch() This method cancels a pending batch by canceling each payment in the batch if the following rules apply.
void	changeStatus(PaymentGroup paymentGroup, String newPaymentStatus, String changeStatus, String note, org.kuali.rice.kim.bo.Person user) This method changes the status for PaymentGroup and PaymentGroupHistory.
boolean	doBatchPaymentsHaveHeldStatus(Integer batchId) This method checks if batch payments have held status.
boolean	doBatchPaymentsHaveOpenOrHeldStatus(Integer batchId) This method checks if batch payments has open or held payments.
boolean	doBatchPaymentsHaveOpenStatus(Integer batchId) This method checks if the batch has open payments.
boolean	holdPendingBatch(Integer paymentBatchId, String note, org.kuali.rice.kim.bo.Person user) holdPendingBatch() This method holds a pending batch by holding each payment in the batch if the following rules apply.
boolean	removeBatchHold(Integer paymentBatchId, String note, org.kuali.rice.kim.bo.Person user) removeBatchHold() This method removes holds on batches of payments if the following rules apply.
void	setBatchMaintenanceDao(BatchMaintenanceDao batchMaintenanceDao) This method sets the batchMaintenanceDao
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService) Sets the business object service
void	setPaymentGroupService(PaymentGroupService paymentGroupService)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchMaintenanceServiceImpl

public BatchMaintenanceServiceImpl()

Method Detail

changeStatus

public void changeStatus(PaymentGroup paymentGroup,
                         String newPaymentStatus,
                         String changeStatus,
                         String note,
                         org.kuali.rice.kim.bo.Person user)

This method changes the status for PaymentGroup and PaymentGroupHistory.

Parameters:

paymentGroup - the PaymentGroup to change the status

newPaymentStatus - the new payment status

changeStatus - the payment change status code

note - a note from the user

cancelPendingBatch

public boolean cancelPendingBatch(Integer paymentBatchId,
                                  String note,
                                  org.kuali.rice.kim.bo.Person user)

cancelPendingBatch() This method cancels a pending batch by canceling each payment in the batch if the following rules apply. - All payments must have a status of 'OPEN'.

Specified by:

cancelPendingBatch in interface BatchMaintenanceService

Parameters:

paymentBatchId - (Integer) Primary key of the Pending Batch to be canceled.

note - (String) Change note text entered by user.

user - (User) Actor making change.

Returns:

true if batch successfully canceled, false otherwise

holdPendingBatch

public boolean holdPendingBatch(Integer paymentBatchId,
                                String note,
                                org.kuali.rice.kim.bo.Person user)

holdPendingBatch() This method holds a pending batch by holding each payment in the batch if the following rules apply. - All payments must have a status of 'OPEN'.

Specified by:

holdPendingBatch in interface BatchMaintenanceService

Parameters:

paymentBatchId - (Integer) Primary key of the Pending Batch to be held.

note - (String) Change note text entered by user.

user - (User) Actor making change.

Returns:

true if batch successfully hold, false otherwise

removeBatchHold

public boolean removeBatchHold(Integer paymentBatchId,
                               String note,
                               org.kuali.rice.kim.bo.Person user)

removeBatchHold() This method removes holds on batches of payments if the following rules apply. - All Payments' statuses in batch must be: "held".

Specified by:

removeBatchHold in interface BatchMaintenanceService

Parameters:

paymentBatchId - (Integer) Primary key of the Pending Batch to be released from hold.

note - (String) Change note text entered by user.

user - (User) Actor making change.

Returns:

true if batch hold successfully removed, false otherwise

doBatchPaymentsHaveOpenStatus

public boolean doBatchPaymentsHaveOpenStatus(Integer batchId)

Description copied from interface: BatchMaintenanceService

This method checks if the batch has open payments.

Specified by:

doBatchPaymentsHaveOpenStatus in interface BatchMaintenanceService

Parameters:

batchId - the id of the batch

Returns:

returns true if batch has open payments, false otherwise

See Also:

org.kuali.kfs.pdp.document.service.BatchMaintenanceService#doBatchPaymentsHaveOpenStatus(java.lang.Integer)

doBatchPaymentsHaveHeldStatus

public boolean doBatchPaymentsHaveHeldStatus(Integer batchId)

Description copied from interface: BatchMaintenanceService

This method checks if batch payments have held status.

Specified by:

doBatchPaymentsHaveHeldStatus in interface BatchMaintenanceService

Parameters:

batchId - the id of the batch

Returns:

true if batch payments have held status, false otherwise

See Also:

org.kuali.kfs.pdp.document.service.BatchMaintenanceService#doBatchPaymentsHaveHeldStatus(java.lang.Integer)

doBatchPaymentsHaveOpenOrHeldStatus

public boolean doBatchPaymentsHaveOpenOrHeldStatus(Integer batchId)

Description copied from interface: BatchMaintenanceService

This method checks if batch payments has open or held payments.

Specified by:

doBatchPaymentsHaveOpenOrHeldStatus in interface BatchMaintenanceService

Parameters:

batchId - the id of the batch

Returns:

true if batch has open or held payments, false otherwise

See Also:

org.kuali.kfs.pdp.document.service.BatchMaintenanceService#doBatchPaymentsHaveOpenOrHeldStatus(java.lang.Integer)

setBatchMaintenanceDao

public void setBatchMaintenanceDao(BatchMaintenanceDao batchMaintenanceDao)

This method sets the batchMaintenanceDao

Parameters:

batchMaintenanceDao - BatchMaintenanceDao

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService)

Sets the business object service

Parameters:

businessObjectService -

setPaymentGroupService

public void setPaymentGroupService(PaymentGroupService paymentGroupService)