SilverStream
Application Server 3.5

com.sssw.srv.ejb
Class AgoEJBEntityHome

java.lang.Object
 |
 +--com.sssw.srv.ejb.AgoEJBHome
       |
       +--com.sssw.srv.ejb.AgoEJBEntityHome
All Implemented Interfaces:
Cloneable, EJBHome, EventListener, HttpSessionBindingListener, Remote

public class AgoEJBEntityHome
extends com.sssw.srv.ejb.AgoEJBHome
implements EJBHome

The base class (factory) used to derive Entity Home classes for EntityBeans


Field Summary
static int FIND_SINGLETON
          Indicates the expected return from a finder method.
 
Fields inherited from class com.sssw.srv.ejb.AgoEJBHome
m_beanClass, m_beanClassLoader, m_container, m_containerStats, m_containerTransactionContext, m_dataSets, m_handle, m_homeBase, m_homeFactory, m_homeInterfaceClass, m_homes, m_IC, m_info, m_jarStats, m_metaData, m_objectClass, m_OldBeanEnv, m_primaryKeyClass, m_remoteInterfaceClass, m_remoteStub, m_session, m_sessionIdHash, m_stats, m_useCache
 
Constructor Summary
AgoEJBEntityHome()
           
 
Method Summary
 Object findByExpression(String whereClause, String orderByClause, int returnType, boolean distinct, int maxClientRows)
          Call this method when you write your own Entity Bean Finder methods.
 
Methods inherited from class com.sssw.srv.ejb.AgoEJBHome
checkEJBBegin, checkEJBEnd, checkSecurityBegin, checkSecurityEnd, checkTransactionBegin, checkTransactionEnd, doHomeCleanup, getClassLoader, getContainer, getEJBMetaData, getHomeHandle, getHomeStatistics, getInfo, getOwnerJarStatistics, getSession, handleCallbackExceptions, handleSystemExceptions, handleSystemExceptions, homeForSession, initialize, remove, remove, restoreBeanEnvironmentMeta, setBeanEnvironmentMeta, valueBound, valueUnbound
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FIND_SINGLETON

public static final int FIND_SINGLETON
Indicates the expected return from a finder method.
Constructor Detail

AgoEJBEntityHome

public AgoEJBEntityHome()
Method Detail

findByExpression

public Object findByExpression(String whereClause,
                               String orderByClause,
                               int returnType,
                               boolean distinct,
                               int maxClientRows)
                        throws RemoteException,
                               FinderException
Call this method when you write your own Entity Bean Finder methods. You might write your own finder methods for CMP Entity Beans if you cannot construct the correct Where clause using SilverStream's Expression Builder. You might also write your own finder methods if you want to specify an Order By clause.

Both the Where and Order By clauses must be constructed following SilverStream's expresion rules.

If you write your own Finder methods the whole row gets retrieved, not just primary keys, so delaying instantiation does not have any effect.

Parameters:
expression - 'where' clause expression composed in accordance with SilverStream expression rules
orderBy - "order by' clause composed in accordance with SilverStream expression rules
returnType - specifies the type of remote reference that is returned (can be Enumeration, Collection or singleton)
maxClientRows - if not 0, will limit the number of rows retrieved
Returns:
Object a Collection/Enumeration/Singleton of object references to the beans that satisfy passed criterion. If bean is lazy (delay instantiation is true), object references have only primary keys in them, non-lazy beans will also have its entire database row (m_row). The bean itself is not instantiated until at least one of its methods or remove(...) is called.
Throws:
RemoteException - if returnType is FIND_SINGLETON and more than 1 row is returned

SilverStream
Application Server 3.5