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

All Superinterfaces:

javax.ejb.EJBHome, IndexMetaDataFinders, java.rmi.Remote

public interface IndexMetaDataHome

extends IndexMetaDataFinders, javax.ejb.EJBHome

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

Field Summary

static java.lang.String

JNDI_LOOKUP_NAME The name this EJB will be registered under JNDI.

Method Summary

IndexMetaData	create(java.lang.String indexName, java.lang.String cacheName, java.lang.String dataPacketName, java.lang.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

public static final java.lang.String JNDI_LOOKUP_NAME

The name this EJB will be registered under JNDI.

See Also:

Constant Field Values

Method Detail

create

public IndexMetaData create(java.lang.String indexName,
                            java.lang.String cacheName,
                            java.lang.String dataPacketName,
                            java.lang.String dataPacketField)
                     throws java.rmi.RemoteException,
                            javax.ejb.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:

javax.ejb.CreateException

java.rmi.RemoteException

findByPrimaryKey

public IndexMetaData findByPrimaryKey(IndexMetaDataPK key)
                               throws java.rmi.RemoteException,
                                      javax.ejb.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:

java.rmi.RemoteException

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