<html>
<head>
</head>
<body bgcolor="#ffffff">
<h2>EjbPersistent</h2>
<p>Implemented in class <a href="../api/xdoclet/modules/ejb/entity/PersistentTagsHandler.html">xdoclet.modules.ejb.entity.PersistentTagsHandler</a>.</p>
<ul>
<li><a href="#block">Block Tags</a>
<li><a href="#content">Content Tags</a>
</ul>
<h3><a name="block">Block Tags:</a></h3>
<h4><a name="forAllBeans">forAllBeans</a> (block template)</h4>
<p>Evaluates the body block for each EJBean derived from one of the three EJB types: EntityBean, SessionBean or MessageDrivenBean.</p>
<h4><a name="forAllCmpEntityBeans">forAllCmpEntityBeans</a> (block template)</h4>
<p>Evaluates the body block for each EJBean derived from EntityBean which is CMP.</p>
<h4><a name="forAllCmpFields">forAllCmpFields</a> (block template)</h4>
<p>Evaluates the body block for each persistent field of current class (if entity CMP). Looks at super classes as well. Searches for the getter methods which has ejb:persistent-field defined.</p>
<h4><a name="forAllEjbSelectMethods">forAllEjbSelectMethods</a> (block template)</h4>
<p>Evaluates the body block for each ejbSelect<blabla> method.</p>
<h4><a name="forAllEntityBeans">forAllEntityBeans</a> (block template)</h4>
<p>Evaluates the body block for each EJBean derived from EntityBean.</p>
<h4><a name="forAllPersistentFields">forAllPersistentFields</a> (block template)</h4>
<p>Evaluates the body for each persistent field. If only-pk="true" then use only primary keys, if not-pk="true" then use only persistent fields that are not primary keys. By default use all regardless of being primary key field or not.</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
[superclasses]
</i>
</td>
<td width="75%" valign="top">
Include persistent fields of superclasses. True by default.<br></br>
Valid Values = {true,false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
[valueobject]
</i>
</td>
<td width="75%" valign="top">
If present, only loop over fields with a matching \@ejb.value-object tag.<br></br>
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
[only-pk]
</i>
</td>
<td width="75%" valign="top">
If true, only loop over the persistent fields that are in the primary key. False by default.<br></br>
Valid Values = {true,false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
[not-pk]
</i>
</td>
<td width="75%" valign="top">
If true, only loop over the persistent fields that are not in the primary key. False by default.<br></br>
Valid Values = {true,false}
</td>
</tr>
</table>
<h4><a name="ifEntity">ifEntity</a> (block template)</h4>
<p>Evaluate the body block if current class is of an entity type.</p>
<h4><a name="ifEntityIsCmp">ifEntityIsCmp</a> (block template)</h4>
<p>Evaluates the body block if current class is an CMP entity bean.</p>
<h4><a name="ifHasAtLeastOnePersistentField">ifHasAtLeastOnePersistentField</a> (block template)</h4>
<p>Evaluates the body if the class has at least one persistent field.</p>
<h4><a name="ifHasAtLeastOnePkField">ifHasAtLeastOnePkField</a> (block template)</h4>
<p>Evaluates the body if the class has at least one primary key field.</p>
<h4><a name="ifIsAConcreteEJBean">ifIsAConcreteEJBean</a> (block template)</h4>
<p>Evaluates the body block if current bean is a concrete bean meaning the generate parameter of ejb:bean is either not specified or equals to "true", otherwise the bean is just an abstract base class bean not meant to be used as a EJBean but serve as the base for other EJBeans.</p>
<h4><a name="ifLocalEjb">ifLocalEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifNotLocalEjb">ifNotLocalEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifNotRemoteEjb">ifNotRemoteEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifNotServiceEndpointEjb">ifNotServiceEndpointEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifNotUsingCmp2">ifNotUsingCmp2</a> (block template)</h4>
<p>Evaluate the body block if not using EJB 2.0 or using EJB 2.0 but CMP version 1.x.</p>
<h4><a name="ifRemoteEjb">ifRemoteEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifServiceEndpointEjb">ifServiceEndpointEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifUsingCmp2">ifUsingCmp2</a> (block template)</h4>
<p>Evaluate the body block if using EJB 2.0 and CMP version 2.x.</p>
<h3><a name="content">Content templates:</a></h3>
<h4><a name="beanType">beanType</a> (content template)</h4>
<p>Returns Bean type : "Entity", "Session" or "Message Driven".</p>
<h4><a name="concreteFullClassName">concreteFullClassName</a> (content template)</h4>
<p>Returns the full-qualified name of the current class's concrete class. This is the class that is generated and is derived from current class.</p>
<h4><a name="ejbExternalRefName">ejbExternalRefName</a> (content template)</h4>
<p>Returns the name of EJB ref.</p>
<h4><a name="ejbName">ejbName</a> (content template)</h4>
<p>Returns the name of current EJB bean.</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
[prefixWithEjbSlash]
</i>
</td>
<td width="75%" valign="top">
Specifies whether to prefix it with ejb/ or not. False by default.<br></br>
Valid Values = {true,false}
</td>
</tr>
</table>
<h4><a name="ejbRefName">ejbRefName</a> (content template)</h4>
<p>Returns the name of EJB ref.</p>
<h4><a name="ejbRefName">ejbRefName</a> (content template)</h4>
<p>Returns the name of EJB ref.</p>
<h4><a name="entityCmpClass">entityCmpClass</a> (content template)</h4>
<p>Returns the name of generated CMP class.</p>
<h4><a name="fieldName">fieldName</a> (content template)</h4>
<p>Returns the cmp-version 2.x compatible cmp / cmr field name for the current method.</p>
<h4><a name="id">id</a> (content template)</h4>
<p>Returns unique id for current ejb.</p>
<h4><a name="persistenceType">persistenceType</a> (content template)</h4>
<p>Returns the persistent type of current bean.</p>
<h4><a name="persistentfieldList">persistentfieldList</a> (content template)</h4>
<p>Returns a string containing comma-separated list of persistent fields with their types.</p>
<h4><a name="persistentfieldNameValueList">persistentfieldNameValueList</a> (content template)</h4>
<p>Returns a string containing comma-separated list of persistent fields without their types in fieldname="value" format.</p>
<h4><a name="persistentfieldNameValueList">persistentfieldNameValueList</a> (content template)</h4>
<p>Returns a string containing comma-separated list of persistent fields without their types in fieldname="value" format.</p>
<h4><a name="reentrant">reentrant</a> (content template)</h4>
<p>Returns True if ejb:bean reentrant is true, False otherwise. It does the case conversion trick from true to True and false to False.</p>
<h4><a name="shortEjbName">shortEjbName</a> (content template)</h4>
<p>Returns short version of ejbName(). Example: "foo.bar.MyBean" ->"MyBean", "foo/bar/MyBean" ->"MyBean"</p>
<h4><a name="symbolicClassName">symbolicClassName</a> (content template)</h4>
<p>Returns the symbolic name of the current class. For an EJBean it's the value of ejb:bean's name parameter.</p>
</body>
</html>
