com.aspc.Layers.aspc_app.Notices.plugins

Class RenewalNoticeRunPlugin

java.lang.Object

com.aspc.Layers.aspc_app.Notices.plugins.RenewalNoticeRunPlugin

All Implemented Interfaces:

ExportBuildLinePlugin, ExportSettings, ExportUpdatePlugin

public class RenewalNoticeRunPlugin
extends java.lang.Object
implements ExportBuildLinePlugin, ExportUpdatePlugin, ExportSettings

This plugin handles the processing of renewal notices As each notice is exported it is set to completed and if possible emailed rather then added to output file.
THREAD MODE: SINGLE-THREADED

Since:

October 20, 2004, 9:41 AM

Author:

Mei Xiao

Constructor Summary

Constructors

Constructor and Description
RenewalNoticeRunPlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	buildDetailLine(Exporter exporter, java.lang.StringBuilder buffer, DBObject o) Requests a StringBuilder to be used as the details line for the supplied DBObject Note: If no changes are required then the buffer should be returned
java.lang.StringBuilder	buildHeader(Exporter exporter, java.lang.StringBuilder buffer, DBObject o) Requests a StringBuilder to be used as the header line Note: If no changes are required then the buffer should be returned
java.lang.String	getDisplayName(Exporter exporter, java.lang.String name) Requests a String to be used as the display name This value will be used as the current thread name and for log messages.
java.lang.String	getTransGroupCode(ExporterWithUpdate exporter, java.lang.String cd) This method is called to retrieve the code that will be used on the transaction group record which will group together all transactions for this process If an null or empty code is returned then it is assumed that no transaction group will be created
void	postSave(ExporterWithUpdate exporter, MutableDataSource mds, long transId) This method is called after changes have been applied
void	preSave(ExporterWithUpdate exporter, MutableDataSource mds) This method is called to allow final changes before datasource is saved.
void	preSave(MutableDataSource ds, FileExporter exporter)
void	preUpdate(ExporterWithUpdate exporter, MutableDataSource mds, DBObject mo, java.util.Map fldMap) This method is called before the current dbobject is updated with the list of changes provided in the fldMap Entries can be added or removed from the fldMap which will then be applied by the exporter Changes can also be made directly to the mdbObj supplied

Methods inherited from class java.lang.Object

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

Constructor Detail

RenewalNoticeRunPlugin

public RenewalNoticeRunPlugin()

Method Detail

getDisplayName

public java.lang.String getDisplayName(Exporter exporter,
                                       java.lang.String name)

Description copied from interface: ExportSettings

Requests a String to be used as the display name This value will be used as the current thread name and for log messages. Note: If no changes are required then the name should be returned as is

Specified by:

getDisplayName in interface ExportSettings

Parameters:

exporter - - current exporter that called this method

name - - Default name generated by the exporter

Returns:

A String.

preSave

public void preSave(MutableDataSource ds,
                    FileExporter exporter)

buildHeader

public java.lang.StringBuilder buildHeader(Exporter exporter,
                                           java.lang.StringBuilder buffer,
                                           DBObject o)
                                    throws java.lang.Exception

Description copied from interface: ExportBuildLinePlugin

Requests a StringBuilder to be used as the header line Note: If no changes are required then the buffer should be returned

Specified by:

buildHeader in interface ExportBuildLinePlugin

Parameters:

exporter - - current exporter that called this method

buffer - - A StringBuilder containing the default header line generated by the exporter

o - - The first DBObject read from the results

Returns:

A StringBuilder.

Throws:

java.lang.Exception - - Exception

buildDetailLine

public java.lang.StringBuilder buildDetailLine(Exporter exporter,
                                               java.lang.StringBuilder buffer,
                                               DBObject o)
                                        throws java.lang.Exception

Description copied from interface: ExportBuildLinePlugin

Requests a StringBuilder to be used as the details line for the supplied DBObject Note: If no changes are required then the buffer should be returned

Specified by:

buildDetailLine in interface ExportBuildLinePlugin

Parameters:

exporter - - current exporter that called this method

buffer - - A StringBuilder containing the default output line generated by the exporter

o - - The current DBObject used to generate output line

Returns:

A StringBuilder.

Throws:

java.lang.Exception - - Exception

preSave

public void preSave(ExporterWithUpdate exporter,
                    MutableDataSource mds)
             throws java.lang.Exception

Description copied from interface: ExportUpdatePlugin

This method is called to allow final changes before datasource is saved.

Specified by:

preSave in interface ExportUpdatePlugin

Parameters:

exporter - - current exporter that called this method

mds - - Current mutable data source containing changes for current batch

Throws:

java.lang.Exception - - Exception

postSave

public void postSave(ExporterWithUpdate exporter,
                     MutableDataSource mds,
                     long transId)

Description copied from interface: ExportUpdatePlugin

This method is called after changes have been applied

Specified by:

postSave in interface ExportUpdatePlugin

Parameters:

exporter - - current exporter that called this method

mds - - Current mutable data source containing changes for current batch

transId - transaction id returned from save of datasource

preUpdate

public void preUpdate(@Nonnull
                      ExporterWithUpdate exporter,
                      @Nonnull
                      MutableDataSource mds,
                      @Nonnull
                      DBObject mo,
                      @Nonnull
                      java.util.Map fldMap)
               throws java.lang.Exception

Description copied from interface: ExportUpdatePlugin

This method is called before the current dbobject is updated with the list of changes provided in the fldMap Entries can be added or removed from the fldMap which will then be applied by the exporter Changes can also be made directly to the mdbObj supplied

Specified by:

preUpdate in interface ExportUpdatePlugin

Parameters:

exporter - - current exporter that called this method

mds - - Current mutable data source containing changes for current batch

mo - - A mutable version of the current dbobject

fldMap - - Hashtable of Path/Value pairs

Throws:

java.lang.Exception - - Exception

getTransGroupCode

public java.lang.String getTransGroupCode(ExporterWithUpdate exporter,
                                          java.lang.String cd)

Description copied from interface: ExportUpdatePlugin

This method is called to retrieve the code that will be used on the transaction group record which will group together all transactions for this process If an null or empty code is returned then it is assumed that no transaction group will be created

Specified by:

getTransGroupCode in interface ExportUpdatePlugin

Parameters:

exporter - - current exporter that called this method

cd - - Default code

Returns:

the value