com.aspc.Util.Export.plugins

Interface ExportUpdatePlugin

All Known Implementing Classes:

RenewalNoticeRunPlugin, UpdateTestExportPlugin

public interface ExportUpdatePlugin

These methods are called by the exporter to allow control of the update process
THREAD MODE: SINGLE-THREADED

Since:

13 May 2005, 09:13

Author:

Jason McGrath

Method Summary

Modifier and Type	Method and Description
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	preUpdate(ExporterWithUpdate exporter, MutableDataSource mds, DBObject mdbObj, 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

Method Detail

preSave

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

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

Parameters:

exporter - - current exporter that called this method

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

Throws:

java.lang.Exception - - Exception

postSave

void postSave(ExporterWithUpdate exporter,
              MutableDataSource mds,
              long transId)
       throws java.lang.Exception

This method is called after changes have been applied

Parameters:

transId - transaction id returned from save of datasource

exporter - - current exporter that called this method

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

Throws:

java.lang.Exception - - Exception

preUpdate

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

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

Parameters:

exporter - - current exporter that called this method

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

mdbObj - - A mutable version of the current dbobject

fldMap - - Hashtable of Path/Value pairs

Throws:

java.lang.Exception - - Exception

getTransGroupCode

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

Parameters:

exporter - - current exporter that called this method

cd - - Default code

Returns:

the value