org.openinvoice.entity

Class InvoiceWrapper

java.lang.Object

org.openinvoice.entity.InvoiceWrapper

public class InvoiceWrapper
extends Object

InvoiceWrapper is a wrapper class exposing the invoice related operations. It provides the following operations:

• createInvoice: create a new invoice based on a UBL order payload.
• cloneInvoice: clones a new invoice based on an existing invoice, already stored in the database.
• renderInvoice: renders an existing invoice.
• queryInvoiceRepository: queries the invoice database and creates a report based on the query result.
• deleteInvoice: deletes an existing invoice from the database.

Constructor Summary

Constructors

Constructor and Description
InvoiceWrapper()

Method Summary

Modifier and Type	Method and Description
AbstractDocument	cloneInvoice(InputStream cloneTypeInputStream, OutputStream outputStream, InputStream templateStream) Clones a new invoice based on an existing invoice.
AbstractDocument	createInvoice(InputStream orderTypeStream, OutputStream outputStream, InputStream templateStream) Created a new invoice based on the UBL order information.
void	deleteInvoice(InputStream deleteInputStream) Deletes an existing invoice.
AbstractDocument	queryInvoiceRepository(InputStream queryTypeInput, OutputStream outputStream, InputStream templateStream)
AbstractDocument	renderInvoice(InputStream renderTypeInput, OutputStream outputStream, InputStream templateStream) Renders an existing invoice.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvoiceWrapper

public InvoiceWrapper()

Method Detail

createInvoice

public AbstractDocument createInvoice(InputStream orderTypeStream,
                                      OutputStream outputStream,
                                      InputStream templateStream)
                               throws OpenInvoiceException,
                                      SQLException,
                                      IOException

Created a new invoice based on the UBL order information.

Parameters:

orderTypeStream - contains the UBL OrderType information

Returns:

Invoice

Throws:

PayloadHandler.PayloadParseException

SQLException

OpenInvoiceException

IOException

queryInvoiceRepository

public AbstractDocument queryInvoiceRepository(InputStream queryTypeInput,
                                               OutputStream outputStream,
                                               InputStream templateStream)
                                        throws OpenInvoiceException,
                                               IOException,
                                               SQLException

Throws:

OpenInvoiceException

IOException

SQLException

renderInvoice

public AbstractDocument renderInvoice(InputStream renderTypeInput,
                                      OutputStream outputStream,
                                      InputStream templateStream)
                               throws OpenInvoiceException,
                                      IOException,
                                      SQLException

Renders an existing invoice.

Parameters:

renderTypeInput - contains invoiceNumber of the invoice to be rendered. It may also contain outputFormat.

outputStream - used to write the output of the rendering.

templateStream - the template text containing place holders to be replaced with invoice information.

Throws:

OpenInvoiceException

IOException

SQLException

cloneInvoice

public AbstractDocument cloneInvoice(InputStream cloneTypeInputStream,
                                     OutputStream outputStream,
                                     InputStream templateStream)
                              throws SQLException,
                                     OpenInvoiceException,
                                     IOException

Clones a new invoice based on an existing invoice. If cloneTypeInputStream is null, the latest invoice is used to clone a new invoice.

Parameters:

cloneTypeInputStream - contains optional information needed to clone

Throws:

SQLException

OpenInvoiceException

IOException

deleteInvoice

public void deleteInvoice(InputStream deleteInputStream)
                   throws OpenInvoiceException,
                          IOException,
                          SQLException

Deletes an existing invoice.

Parameters:

deleteInputStream - contains invoiceNumber of the invoice to be deleted.

Throws:

OpenInvoiceException

IOException

SQLException