org.kuali.kfs.pdp.service

Interface FormatService

All Known Implementing Classes:

FormatServiceImpl

public interface FormatService

Method Summary

Methods

Modifier and Type	Method and Description
void	clearUnfinishedFormat(Integer processId) If the start format process was run and the user doesn't want to continue, this needs to be run to set all payments back to open.
void	endFormatProcess(String campus) This method removes the format process from the format process table
List<CustomerProfile>	getAllCustomerProfiles() This method gets all customer profiles
List<DisbursementNumberRange>	getAllDisbursementNumberRanges() This method gets all disbursement number ranges
FormatSelection	getDataForFormat(org.kuali.rice.kim.api.identity.Person user) This method gets the data for the format process
Date	getFormatProcessStartDate(String campus) This method gets the format process by campus code and returns the start date for that process.
void	performFormat(Integer procId) This method formats the data for check printing.
void	resetFormatPayments(Integer procId) If the start format process was run and errored out, this needs to be run to allow formats to continue to function
FormatProcessSummary	startFormatProcess(org.kuali.rice.kim.api.identity.Person user, String campus, List<CustomerProfile> customers, Date paydate, String paymentTypes) This method marks the process log so a format only happens once per campus.

Method Detail

getAllCustomerProfiles

List<CustomerProfile> getAllCustomerProfiles()

This method gets all customer profiles

Returns:

getAllDisbursementNumberRanges

List<DisbursementNumberRange> getAllDisbursementNumberRanges()

This method gets all disbursement number ranges

Returns:

getFormatProcessStartDate

Date getFormatProcessStartDate(String campus)

This method gets the format process by campus code and returns the start date for that process.

Parameters:

campus - the campus code

Returns:

the format process start date if any process found for the given campus code, null otherwise

getDataForFormat

FormatSelection getDataForFormat(org.kuali.rice.kim.api.identity.Person user)

This method gets the data for the format process

Parameters:

user - the user that initiated the format process

Returns:

FormatSelection

performFormat

void performFormat(Integer procId)
                   throws FormatException

This method formats the data for check printing.

Parameters:

procId -

Throws:

FormatException

resetFormatPayments

void resetFormatPayments(Integer procId)

If the start format process was run and errored out, this needs to be run to allow formats to continue to function

Parameters:

procId -

startFormatProcess

FormatProcessSummary startFormatProcess(org.kuali.rice.kim.api.identity.Person user,
                                      String campus,
                                      List<CustomerProfile> customers,
                                      Date paydate,
                                      String paymentTypes)

This method marks the process log so a format only happens once per campus. Mark all the payments that will be formatted and return a summary. attachments will be Y, N or null for both.

Parameters:

user -

campus -

customers -

paydate -

paymentTypes -

Returns:

FormatProcessSummary

endFormatProcess

void endFormatProcess(String campus)

This method removes the format process from the format process table

Parameters:

campus -

clearUnfinishedFormat

void clearUnfinishedFormat(Integer processId)

If the start format process was run and the user doesn't want to continue, this needs to be run to set all payments back to open. This method unmarks the payments and removes the format process entry.

Parameters:

processId -