org.kuali.kfs.module.ar.report.service

Interface TransmitContractsAndGrantsInvoicesService

All Known Implementing Classes:

TransmitContractsAndGrantsInvoicesServiceImpl

public interface TransmitContractsAndGrantsInvoicesService

Service to help the TransmitContractsAndGrantsInvoicesLookupAction

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ContractsGrantsInvoiceDocument>	getInvoicesByParametersFromRequest(Map fieldValues) This seems to collect Contracts & Grants Invoices by the given lookup parameters.
boolean	isInvoiceValidToEmail(ContractsGrantsInvoiceDocument contractsGrantsInvoiceDocument) Is the invoice valid to email (has Email transmission method and hasn't been marked for processing)?
boolean	isInvoiceValidToMail(ContractsGrantsInvoiceDocument contractsGrantsInvoiceDocument) Is the invoice valid to mail (has Mail transmission method and hasn't been processed)?
boolean	printInvoicesAndEnvelopesZip(Collection<ContractsGrantsInvoiceDocument> list, ByteArrayOutputStream baos) This method generates the actual pdf files to print.
boolean	sendEmailForListofInvoicesToAgency(Collection<ContractsGrantsInvoiceDocument> list) This method emails invoices and then sets the report delivery flag.
void	validateSearchParameters(Map<String,String> fieldValues) Validate search parameters for the Transmit Contracts & Grants Invoices lookup.

Method Detail

getInvoicesByParametersFromRequest

Collection<ContractsGrantsInvoiceDocument> getInvoicesByParametersFromRequest(Map fieldValues)
                                                                              throws org.kuali.rice.kew.api.exception.WorkflowException,
                                                                                     ParseException

This seems to collect Contracts & Grants Invoices by the given lookup parameters.

Parameters:

userId - the user carrying out this operation

documentNumber - if present, searches by document number

proposalNumber - if present, searches by the proposal number

invoiceAmount - if present, searches by the invoice amount

chartOfAccountsCode - if present, searches on the chart of accounts code

organizationCode - if present, searches on the organization

unformattedToDate - if present, searches on the to date

unformattedFromDate - if present, searches on the from date

invoiceTransmissionMethodCode - searches for invoice transmission method of EMAIL, MAIL, or BOTH (all invoices)

Returns:

a Collection of ContractsGrantsInvoiceDocument objects

Throws:

org.kuali.rice.kew.api.exception.WorkflowException - thrown if document could not be retrieved

ParseException - thrown if dates could not be parsed

isInvoiceValidToEmail

boolean isInvoiceValidToEmail(ContractsGrantsInvoiceDocument contractsGrantsInvoiceDocument)

Is the invoice valid to email (has Email transmission method and hasn't been marked for processing)?

Parameters:

contractsGrantsInvoiceDocument -

Returns:

true if invoice is valid to email, false otherwise

isInvoiceValidToMail

boolean isInvoiceValidToMail(ContractsGrantsInvoiceDocument contractsGrantsInvoiceDocument)

Is the invoice valid to mail (has Mail transmission method and hasn't been processed)?

Parameters:

contractsGrantsInvoiceDocument -

Returns:

true if invoice is valid to email, false otherwise

printInvoicesAndEnvelopesZip

boolean printInvoicesAndEnvelopesZip(Collection<ContractsGrantsInvoiceDocument> list,
                                   ByteArrayOutputStream baos)
                                     throws com.lowagie.text.DocumentException,
                                            IOException

This method generates the actual pdf files to print.

Parameters:

list - the list of invoice documents to print

a - ByteArrayOutputStream to write out to

Returns:

true if printing succeeded, false otherwise

Throws:

com.lowagie.text.DocumentException - if PDF cannot be written

IOException - if there is some other IO problem

validateSearchParameters

void validateSearchParameters(Map<String,String> fieldValues)

Validate search parameters for the Transmit Contracts & Grants Invoices lookup.

Parameters:

fieldValues - search parameters to validate

sendEmailForListofInvoicesToAgency

boolean sendEmailForListofInvoicesToAgency(Collection<ContractsGrantsInvoiceDocument> list)
                                           throws org.kuali.rice.krad.exception.InvalidAddressException,
                                                  javax.mail.MessagingException

This method emails invoices and then sets the report delivery flag.

Parameters:

list -

Returns:

true if all emails were successfully sent, false otherwise

Throws:

org.kuali.rice.krad.exception.InvalidAddressException

javax.mail.MessagingException