com.bankframe.ejb.bmp
Interface EPersister

All Known Implementing Classes:

CacheIndexPersister, MasterEntityPersister, StoreAndForwardPersister, StoreAndForwardSessionAmendPersister, StoreMasterEntityPersister, TxnPersister, TxnPersister, TxnSessionAmendPersister

public interface EPersister

This interface defines the methods that all Persister classes must implement.

Method Summary

void	amend(EBMPEntity entityBean, String methodName) This method is used to update some or all attributes in the data store.
void	amend(EBMPEntity entityBean, String methodName, DataPacket amendData) This method is used to update some or all attributes in the data store using the specified amendData rather that the entityBean's attributes.
EPrimaryKey	create(EBMPEntity entityBean) This method is used to create an entity in the data store.
Enumeration	find(EBMPEntity entityBean, String methodName, DataPacket finderData) This method is used to find an entity in the data store.
void	load(EBMPEntity entityBean) This method is used to load an entity from the data store.
void	remove(EBMPEntity entityBean) This method is used to remove an entity from the data store.
void	removeFromCache(EBMPEntity entityBean) This method is used to remove an entity from the cache only.
void	store(EBMPEntity entityBean) This method is used to update all attributes in data store.

Method Detail

amend

void amend(EBMPEntity entityBean,
           String methodName)
           throws ProcessingErrorException

This method is used to update some or all attributes in the data store.

Parameters:

entityBean - entity to be updated in the data store

methodName - the name of the method doing the amend

Throws:

ProcessingErrorException - if an error occurs during processing

amend

void amend(EBMPEntity entityBean,
           String methodName,
           DataPacket amendData)
           throws ProcessingErrorException

This method is used to update some or all attributes in the data store using the specified amendData rather that the entityBean's attributes.

Parameters:

entityBean - entity to be updated in the data store

methodName - the name of the method doing the amend

amendData - the data to use for the amend operation

Throws:

ProcessingErrorException - if an error occurs during processing

create

EPrimaryKey create(EBMPEntity entityBean)
                   throws ProcessingErrorException

This method is used to create an entity in the data store.

Parameters:

entityBean - entity to be created in the data store

Returns:

EPrimaryKey returns the primaryKey of the entity

Throws:

ProcessingErrorException - if an error occurs during processing

find

Enumeration find(EBMPEntity entityBean,
                 String methodName,
                 DataPacket finderData)
                 throws ProcessingErrorException

This method is used to find an entity in the data store.

Parameters:

entityBean - entity to be found in the data store

methodName - the name of the method doing the find e.g. findByPrimaryKey()

finderData - the data needed by the data store to conduct search

Returns:

Enumeration returns an enumeration of primaryKeys

Throws:

ProcessingErrorException - thrown if an error occurs during processing

load

void load(EBMPEntity entityBean)
          throws ProcessingErrorException

This method is used to load an entity from the data store.

Parameters:

entityBean - entity to be loaded from the data store

Throws:

ProcessingErrorException - if an error occurs during processing

remove

void remove(EBMPEntity entityBean)
            throws ProcessingErrorException

This method is used to remove an entity from the data store.

Parameters:

entityBean - entity to be removed from the data store

Throws:

ProcessingErrorException - thrown if an error occurs during processing

store

void store(EBMPEntity entityBean)
           throws ProcessingErrorException

This method is used to update all attributes in data store.

Parameters:

entityBean - entity to be stored in the data store

Throws:

ProcessingErrorException - if an error occurs during processing

removeFromCache

void removeFromCache(EBMPEntity entityBean)
                     throws ProcessingErrorException

This method is used to remove an entity from the cache only. Note that not all persister implementations use a cache, in which case this method will have no effect.

Parameters:

entityBean - entity to be removed from the cache

Throws:

ProcessingErrorException - thrown if an error occurs during processing