com.bankframe.services.cache.indexmetadata.impl
Interface IndexMetaDataHome

All Superinterfaces:

EJBHome, IndexMetaDataFinders, Remote

public interface IndexMetaDataHome
extends IndexMetaDataFinders, EJBHome

This class is the home interface of the IndexMetaDataBean defines its create and findByPrimaryKey method

Field Summary

static String

JNDI_LOOKUP_NAME The name this EJB will be registered under JNDI.

Method Summary

IndexMetaData	create(String indexName, String cacheName, String dataPacketName, String dataPacketField) This method initialises a new instance of the IndexMetaData entity.
IndexMetaData	findByPrimaryKey(IndexMetaDataPK key) This method finds an instance of IndexMetaData by its PrimaryKey

Methods inherited from interface com.bankframe.services.cache.indexmetadata.IndexMetaDataFinders

findByIndexName

Methods inherited from interface javax.ejb.EJBHome

getEJBMetaData, getHomeHandle, remove, remove

Field Detail

JNDI_LOOKUP_NAME

static final String JNDI_LOOKUP_NAME

The name this EJB will be registered under JNDI.

See Also:

Constant Field Values

Method Detail

create

IndexMetaData create(String indexName,
                     String cacheName,
                     String dataPacketName,
                     String dataPacketField)
                     throws RemoteException,
                            CreateException

This method initialises a new instance of the IndexMetaData entity.

Parameters:

indexName - indicates the name of the index

cacheName - name of the cache that this index applies to

dataPacketName - the name of the data packet that the index applies to

dataPacketField - the name of the data packet attribute that the index applies to

Returns:

IndexMetaData the instance of the entity

Throws:

CreateException

RemoteException

findByPrimaryKey

IndexMetaData findByPrimaryKey(IndexMetaDataPK key)
                               throws RemoteException,
                                      FinderException

This method finds an instance of IndexMetaData by its PrimaryKey

Parameters:

key - PrimaryKey to use in the search

Returns:

IndexMetaData the instance of the entity

Throws:

RemoteException

FinderException - this exception is thrown if the entity is not found.