Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.tools.ejb11
Class EJBXmlBeanDefinition

java.lang.Object
  extended byoracle.toplink.tools.ejb11.EJBXmlBeanDefinition

Direct Known Subclasses:
EJBXmlEntityBeanDefinition, EJBXmlSessionBeanDefinition

public abstract class EJBXmlBeanDefinition
extends java.lang.Object

This type defines the fields used by the EJB XML deployment descriptor


Field Summary
static java.lang.String BEAN
static java.lang.String CONTAINER
java.lang.Class ejbClass
java.lang.String ejbName
static java.lang.String FALSE
java.lang.Class home
static java.lang.String MANDATORY
static java.lang.String NEVER
static java.lang.String NOT_SUPPORTED
java.lang.Class remote
static java.lang.String REQUIRED
static java.lang.String REQUIRES_NEW
static java.lang.String SUPPORTS
java.lang.String transAttribute
static java.lang.String TRUE

Constructor Summary
EJBXmlBeanDefinition(java.lang.String beanName)
EJBXmlBeanDefinition constructor.

Method Summary
java.lang.Class getEjbClass()
Get the class of the bean.
java.lang.String getEjbName()
Get the name of the bean.
java.lang.Class getHomeClass()
Get the home interface class.
java.lang.Class getRemoteClass()
Get the remote interface class.
java.lang.String getTransAttribute()
Get the transaction management specifier for CMP.
void initializeToDefaults()
Initialize this object to contain the default values.
void setEjbClass(java.lang.Class beanCls)
Set the class of the bean.
void setEjbName(java.lang.String beanName)
Set the name of the bean.
void setHomeClass(java.lang.Class homeCls)
Set the class of the home interface.
void setRemoteClass(java.lang.Class remoteCls)
Set the class of the remote interface.
void setTransAttribute(java.lang.String attrib)
Set the transaction management specifier for CMP.
org.w3c.dom.Element storeAssemblyProperties(org.w3c.dom.Element parentElement, org.w3c.dom.Document xmlDoc)
Store the assembly properties in the element passed in and using the XML document.
org.w3c.dom.Element storeBeanProperties(org.w3c.dom.Element parentElement, org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ejbName

public java.lang.String ejbName

ejbClass

public java.lang.Class ejbClass

home

public java.lang.Class home

remote

public java.lang.Class remote

transAttribute

public java.lang.String transAttribute

CONTAINER

public static final java.lang.String CONTAINER
See Also:
Constant Field Values

BEAN

public static final java.lang.String BEAN
See Also:
Constant Field Values

NOT_SUPPORTED

public static final java.lang.String NOT_SUPPORTED
See Also:
Constant Field Values

SUPPORTS

public static final java.lang.String SUPPORTS
See Also:
Constant Field Values

REQUIRED

public static final java.lang.String REQUIRED
See Also:
Constant Field Values

REQUIRES_NEW

public static final java.lang.String REQUIRES_NEW
See Also:
Constant Field Values

MANDATORY

public static final java.lang.String MANDATORY
See Also:
Constant Field Values

NEVER

public static final java.lang.String NEVER
See Also:
Constant Field Values

TRUE

public static final java.lang.String TRUE
See Also:
Constant Field Values

FALSE

public static final java.lang.String FALSE
See Also:
Constant Field Values

Constructor Detail

EJBXmlBeanDefinition

public EJBXmlBeanDefinition(java.lang.String beanName)
EJBXmlBeanDefinition constructor.

Method Detail

getEjbClass

public java.lang.Class getEjbClass()
Get the class of the bean.
Returns:
Class The bean implementation Class

getEjbName

public java.lang.String getEjbName()
Get the name of the bean. This name is not used for anything other than referencing this bean in the deployment descriptor
Returns:
String The arbitrary String chosen by the bean provider

getHomeClass

public java.lang.Class getHomeClass()
Get the home interface class.
Returns:
Class The home interface Class

getRemoteClass

public java.lang.Class getRemoteClass()
Get the remote interface class.
Returns:
Class The remote interface Class

getTransAttribute

public java.lang.String getTransAttribute()
Get the transaction management specifier for CMP.
Returns:
String Can be any one of: NOT_SUPPORTED, SUPPORTS, REQUIRED, REQUIRES_NEW, MANDATORY ,or NEVER

initializeToDefaults

public void initializeToDefaults()
Initialize this object to contain the default values.

setEjbClass

public void setEjbClass(java.lang.Class beanCls)
Set the class of the bean.
Parameters:
beanCls - The bean implementation Class

setEjbName

public void setEjbName(java.lang.String beanName)
Set the name of the bean. This name is not used for anything other than referencing this bean in the deployment descriptor
Parameters:
beanName - The arbitrary String chosen by the bean provider

setHomeClass

public void setHomeClass(java.lang.Class homeCls)
Set the class of the home interface.
Parameters:
homeCls - The home interface Class

setRemoteClass

public void setRemoteClass(java.lang.Class remoteCls)
Set the class of the remote interface.
Parameters:
remoteCls - The remote interface Class

setTransAttribute

public void setTransAttribute(java.lang.String attrib)
Set the transaction management specifier for CMP.
Parameters:
attrib - Can be set to any of: NOT_SUPPORTED, SUPPORTS, REQUIRED, REQUIRES_NEW, MANDATORY ,or NEVER

storeAssemblyProperties

public org.w3c.dom.Element storeAssemblyProperties(org.w3c.dom.Element parentElement,
                                                   org.w3c.dom.Document xmlDoc)
Store the assembly properties in the element passed in and using the XML document.
Returns:
Element The parent element

storeBeanProperties

public org.w3c.dom.Element storeBeanProperties(org.w3c.dom.Element parentElement,
                                               org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.
Returns:
Element The parent element

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.