org.kuali.kfs.pdp.service
Interface BatchMaintenanceService

All Known Implementing Classes:

BatchMaintenanceServiceImpl

public interface BatchMaintenanceService

This class defines services for Batch maintenance.

Method Summary

boolean	cancelPendingBatch(Integer batchId, String note, org.kuali.rice.kim.bo.Person user) This method cancels a pending Batch.
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 batchId, String note, org.kuali.rice.kim.bo.Person user) This method holds a pending Batch.
boolean	removeBatchHold(Integer batchId, String changeText, org.kuali.rice.kim.bo.Person user) This method removes a hold on a Batch.

Method Detail

cancelPendingBatch

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

This method cancels a pending Batch.

Parameters:

batchId - the id of the batch to be canceled

note - a note stating the reason for the batch cancelation

user - the user that performed the batch cancelation

Returns:

true if batch successfully canceled, false otherwise

holdPendingBatch

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

This method holds a pending Batch.

Parameters:

batchId - the id of the batch to perfomr hold on

note - a nite stating the reason for holding batch

user - the user that performed the batch hold

Returns:

true if batch successfully hold, false otherwise

removeBatchHold

boolean removeBatchHold(Integer batchId,
                        String changeText,
                        org.kuali.rice.kim.bo.Person user)

This method removes a hold on a Batch.

Parameters:

batchId - the id of the batch we want to remove the hold

changeText - a text stating the reason for removing the hold

user - the user that removed hold on batch

Returns:

true if batch hold successfully removed, false otherwise

doBatchPaymentsHaveOpenStatus

boolean doBatchPaymentsHaveOpenStatus(Integer batchId)

This method checks if the batch has open payments.

Parameters:

batchId - the id of the batch

Returns:

returns true if batch has open payments, false otherwise

doBatchPaymentsHaveOpenOrHeldStatus

boolean doBatchPaymentsHaveOpenOrHeldStatus(Integer batchId)

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

Parameters:

batchId - the id of the batch

Returns:

true if batch has open or held payments, false otherwise

doBatchPaymentsHaveHeldStatus

boolean doBatchPaymentsHaveHeldStatus(Integer batchId)

This method checks if batch payments have held status.

Parameters:

batchId - the id of the batch

Returns:

true if batch payments have held status, false otherwise