blob: a810bc5fcaf6e4d7dbcb46ae48bcbb13bfd591ca [file] [log] [blame]
<html lang=en>
<head>
<meta name="Generated by Rational Rose model" content="D:\work\WTP\org.eclipse.jst.j2ee.core\rose\j2ee.mdl">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Description" content="The entity element declares an entity bean. The declaration consists of: an optional description; optional display name; optional small icon file name; optional large icon file name; a unique name assigned to the enterprise bean in the deployment descriptor; the names of the entity bean’s home and remote interfaces, if any; the names of the entity bean’s local home and local interface, if any; the entity bean’s implementation class; the entity bean’s persistence management type; the entity bean’s primary key class name; an indication of the entity bean’s reentrancy; an optional specification of the entity bean’s cmp-version; an optional specification of the entity bean’s abstract schema name; an optional list of container-managed fields; an optional specification of the primary key field; an optional declaration of the bean’s environment entries; an optional declaration of the bean’s EJB references; an optional declaration of the bean’s local EJB references; an optional declaration of the security role references; an optional declaration of the security identity to be used for the execution of the bean’s methods; an optional declaration of the bean’s resource manager connection factory references; an optional declaration of the bean’s resource environment references; an optional set of query declarations for finder and select methods for an entity bean with cmp-version 2.x. The optional abstract-schema-name element must be specified for an entity bean with container managed persistence and cmp-version 2.x. The optional primkey-field may be present in the descriptor if the entity’s persistence-type is Container. The optional cmp-version element may be present in the descriptor if the entity’s persistence-type is Container. If the persistence-type is Container and the cmp-version element is not specified, its value defaults to 2.x. The optional home and remote elements must be specified if the entity bean cmp-version is 1.x. The optional local-home and local elements must be specified if the entity bean has a local home and local interface. The optional query elements must be present if the persistence-type is Container and the cmp-version is 2.x and query methods other than findByPrimaryKey have been defined for the entity bean. The other elements that are optional are optional in the sense that they are omitted if the lists represented by them are empty. At least one cmp-field element must be present in the descriptor if the entity’s persistence-type is Container and the cmp-version is 1.x, and none must not be present if the entity’s persistence-type is Bean.">
<meta name="KeyWords" content="Entity,Class Entity,j2ee,model j2ee,">
<a href="../../root.html" target=_top><IMG SRC="../../webviewer/home.gif"BORDER=0></a>
</head>
<body bgcolor = "#FFFFFF">
<p><font FACE="Arial, Geneva" SIZE=3><b>Class&nbsp;Entity&nbsp;{Java}&nbsp;derived&nbsp;from:&nbsp;<a href="class3780e71a010a.htm" target="contents_frame">EnterpriseBean</a></b></font></p>
<font FACE="Arial, Geneva" SIZE=2><b>Documentation</b></font><BR><font FACE="Arial, Geneva" SIZE=2>The&nbsp;entity&nbsp;element&nbsp;declares&nbsp;an&nbsp;entity&nbsp;bean.&nbsp;The&nbsp;declaration&nbsp;consists&nbsp;of:&nbsp;an&nbsp;optional&nbsp;description;&nbsp;optional&nbsp;display&nbsp;name;&nbsp;optional&nbsp;small&nbsp;icon&nbsp;file&nbsp;name;&nbsp;optional&nbsp;large&nbsp;icon&nbsp;file&nbsp;name;&nbsp;a&nbsp;unique&nbsp;name&nbsp;assigned&nbsp;to&nbsp;the&nbsp;enterprise&nbsp;bean&nbsp;in&nbsp;the&nbsp;deployment&nbsp;descriptor;&nbsp;the&nbsp;names&nbsp;of&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;home&nbsp;and&nbsp;remote&nbsp;interfaces,&nbsp;if&nbsp;any;&nbsp;the&nbsp;names&nbsp;of&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;local&nbsp;home&nbsp;and&nbsp;local&nbsp;interface,&nbsp;if&nbsp;any;&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;implementation&nbsp;class;&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;persistence&nbsp;management&nbsp;type;&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;primary&nbsp;key&nbsp;class&nbsp;name;&nbsp;an&nbsp;indication&nbsp;of&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;reentrancy;&nbsp;an&nbsp;optional&nbsp;specification&nbsp;of&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;cmp-version;&nbsp;an&nbsp;optional&nbsp;specification&nbsp;of&nbsp;the&nbsp;entity&nbsp;bean’s&nbsp;abstract&nbsp;schema&nbsp;name;&nbsp;an&nbsp;optional&nbsp;list&nbsp;of&nbsp;container-managed&nbsp;fields;&nbsp;an&nbsp;optional&nbsp;specification&nbsp;of&nbsp;the&nbsp;primary&nbsp;key&nbsp;field;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;environment&nbsp;entries;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;EJB&nbsp;references;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;local&nbsp;EJB&nbsp;references;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;security&nbsp;role&nbsp;references;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;security&nbsp;identity&nbsp;to&nbsp;be&nbsp;used&nbsp;for&nbsp;the&nbsp;execution&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;methods;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;resource&nbsp;manager&nbsp;connection&nbsp;factory&nbsp;references;&nbsp;an&nbsp;optional&nbsp;declaration&nbsp;of&nbsp;the&nbsp;bean’s&nbsp;resource&nbsp;environment&nbsp;references;&nbsp;an&nbsp;optional&nbsp;set&nbsp;of&nbsp;query&nbsp;declarations&nbsp;for&nbsp;finder&nbsp;and&nbsp;select&nbsp;methods&nbsp;for&nbsp;an&nbsp;entity&nbsp;bean&nbsp;with&nbsp;cmp-version&nbsp;2.x.
<BR>The&nbsp;optional&nbsp;abstract-schema-name&nbsp;element&nbsp;must&nbsp;be&nbsp;specified&nbsp;for&nbsp;an&nbsp;entity&nbsp;bean&nbsp;with&nbsp;container&nbsp;managed&nbsp;persistence&nbsp;and&nbsp;cmp-version&nbsp;2.x.&nbsp;The&nbsp;optional&nbsp;primkey-field&nbsp;may&nbsp;be&nbsp;present&nbsp;in&nbsp;the&nbsp;descriptor&nbsp;if&nbsp;the&nbsp;entity’s&nbsp;persistence-type&nbsp;is&nbsp;Container.&nbsp;The&nbsp;optional&nbsp;cmp-version&nbsp;element&nbsp;may&nbsp;be&nbsp;present&nbsp;in&nbsp;the&nbsp;descriptor&nbsp;if&nbsp;the&nbsp;entity’s&nbsp;persistence-type&nbsp;is&nbsp;Container.&nbsp;If&nbsp;the&nbsp;persistence-type&nbsp;is&nbsp;Container&nbsp;and&nbsp;the&nbsp;cmp-version&nbsp;element&nbsp;is&nbsp;not&nbsp;specified,&nbsp;its&nbsp;value&nbsp;defaults&nbsp;to&nbsp;2.x.
<BR>The&nbsp;optional&nbsp;home&nbsp;and&nbsp;remote&nbsp;elements&nbsp;must&nbsp;be&nbsp;specified&nbsp;if&nbsp;the&nbsp;entity&nbsp;bean&nbsp;cmp-version&nbsp;is&nbsp;1.x.
<BR>The&nbsp;optional&nbsp;local-home&nbsp;and&nbsp;local&nbsp;elements&nbsp;must&nbsp;be&nbsp;specified&nbsp;if&nbsp;the&nbsp;entity&nbsp;bean&nbsp;has&nbsp;a&nbsp;local&nbsp;home&nbsp;and&nbsp;local&nbsp;interface.
<BR>The&nbsp;optional&nbsp;query&nbsp;elements&nbsp;must&nbsp;be&nbsp;present&nbsp;if&nbsp;the&nbsp;persistence-type&nbsp;is&nbsp;Container&nbsp;and&nbsp;the&nbsp;cmp-version&nbsp;is&nbsp;2.x&nbsp;and&nbsp;query&nbsp;methods&nbsp;other&nbsp;than&nbsp;findByPrimaryKey&nbsp;have&nbsp;been&nbsp;defined&nbsp;for&nbsp;the&nbsp;entity&nbsp;bean.
<BR>The&nbsp;other&nbsp;elements&nbsp;that&nbsp;are&nbsp;optional&nbsp;are&nbsp;"optional"&nbsp;in&nbsp;the&nbsp;sense&nbsp;that&nbsp;they&nbsp;are&nbsp;omitted&nbsp;if&nbsp;the&nbsp;lists&nbsp;represented&nbsp;by&nbsp;them&nbsp;are&nbsp;empty.&nbsp;At&nbsp;least&nbsp;one&nbsp;cmp-field&nbsp;element&nbsp;must&nbsp;be&nbsp;present&nbsp;in&nbsp;the&nbsp;descriptor&nbsp;if
<BR>the&nbsp;entity’s&nbsp;persistence-type&nbsp;is&nbsp;Container&nbsp;and&nbsp;the&nbsp;cmp-version&nbsp;is&nbsp;1.x,&nbsp;and&nbsp;none&nbsp;must&nbsp;not&nbsp;be&nbsp;present&nbsp;if&nbsp;the&nbsp;entity’s&nbsp;persistence-type&nbsp;is&nbsp;Bean.</font><BR><BR>
</body>
</html>