com.neurosys.ecom.orders.service

Class TemplateInvoiceService<O extends Order<I>,I extends OrderItem,INVOICE>

java.lang.Object

com.neurosys.ecom.orders.service.TemplateInvoiceService<O,I,INVOICE>

Type Parameters:

O - as Order

I - as OrderItem

INVOICE - as Invoice data structure

All Implemented Interfaces:

InvoiceService<O,I,INVOICE>, ChangeGenerator<Object>

Direct Known Subclasses:

SpringTemplateInvoiceService

public abstract class TemplateInvoiceService<O extends Order<I>,I extends OrderItem,INVOICE>
extends Object
implements InvoiceService<O,I,INVOICE>

Using a Publisher publish an Invoice Format (Default @ HTML); where the Order is provided to the context with order + processContext(Order, Map):
The order passed is expected to contain all the necessary details ready for Publishing/Printing to the invoice.
To further process and add to the context; one may override #processContext(Order, Publisher)

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
TemplateInvoiceService()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
protected INVOICE	convertStreamToInvoice(Writer writer) Using the writer produce the final INVOICE output.
INVOICE	generateInvoice(O order) Generate the INVOICE
ExportType	getInvoiceType() Mime type/Extension etc if any
List	getListeners() Get list directly.
protected abstract Publisher	getPublisher(O order) Get Publisher for each instance request
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
protected void	processContext(O order, Map dataMap) Can process order to derive other intermediate context variables and put them in the context Map.
void	setListeners(List listeners) Set list directly.
protected void	updateInvoiceHistory(O order, INVOICE invoice) By Default no Invoice history is maintained.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateInvoiceService

public TemplateInvoiceService()

Method Detail

getPublisher

protected abstract Publisher getPublisher(O order)

Get Publisher for each instance request

Returns:

updateInvoiceHistory

@Transactional(readOnly=false)
protected void updateInvoiceHistory(O order,
                                                                   INVOICE invoice)
                                                            throws Exception

By Default no Invoice history is maintained.
However one can override this method or write an InvoiceChangeListener and attach it as a Listener wrapped inside a AsynchronousChangeListener

Parameters:

order -

invoice -

Throws:

Exception

generateInvoice

@Transactional(readOnly=false)
public INVOICE generateInvoice(O order)

Description copied from interface: InvoiceService

Generate the INVOICE

Specified by:

generateInvoice in interface InvoiceService<O extends Order<I>,I extends OrderItem,INVOICE>

Returns:

INVOICE

processContext

protected void processContext(O order,
                              Map dataMap)

Can process order to derive other intermediate context variables and put them in the context Map.
By default ADD's the following in context:

• userContactDetailsJsonObject
• shippingAddress - From userContactDetails or User Object
• billingAddress - From userContactDetails or User Object
• firstName - From userContactDetails or User Object
• lastName - From userContactDetails or User Object
• email - From userContactDetails or User Object
• phone - From userContactDetails or User Object
• currentDate - Current date of generation Date (If new it will update the order object)

Parameters:

order -

context -

convertStreamToInvoice

protected INVOICE convertStreamToInvoice(Writer writer)

Using the writer produce the final INVOICE output.

Parameters:

writer - as Writer

Returns:

getInvoiceType

public ExportType getInvoiceType()

Description copied from interface: InvoiceService

Mime type/Extension etc if any

Specified by:

getInvoiceType in interface InvoiceService<O extends Order<I>,I extends OrderItem,INVOICE>

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object>

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object>