<html>
<head>
</head>
<body bgcolor="#ffffff">
<h2>EjbPk</h2>
<p>Implemented in class <a href="../api/xdoclet/modules/ejb/entity/PkTagsHandler.html">xdoclet.modules.ejb.entity.PkTagsHandler</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="ifDoesntHavePrimkeyField">ifDoesntHavePrimkeyField</a> (block template)</h4>
<p>Process the tag body if the current class doesn't have a defined primkey-field.</p>
<h4><a name="ifHasPrimkeyField">ifHasPrimkeyField</a> (block template)</h4>
<p>Process the tag body if the current class has a defined primkey-field.</p>
<h4><a name="ifHasPrimkeySetter">ifHasPrimkeySetter</a> (block template)</h4>
<p>Process the tag body if the current class has defined a setter for the primkey-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="ifIsNotPrimkeyField">ifIsNotPrimkeyField</a> (block template)</h4>
<p>Process the tag body if the current method is not a getter or setter for the primkey-field.</p>
<h4><a name="ifIsPkField">ifIsPkField</a> (block template)</h4>
<p>Evaluates the body if the current method is a primary key field.</p>
<h4><a name="ifIsPrimkeyField">ifIsPrimkeyField</a> (block template)</h4>
<p>Process the tag body if the current method is a getter or setter for the primkey-field.</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="ifRemoteEjb">ifRemoteEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifServiceEndpointEjb">ifServiceEndpointEjb</a> (block template)</h4>
<p></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="extendsFrom">extendsFrom</a> (content template)</h4>
<p>Returns the name of the class pk class extends.</p>
<h4><a name="id">id</a> (content template)</h4>
<p>Returns unique id for current ejb.</p>
<h4><a name="pkClass">pkClass</a> (content template)</h4>
<p>Returns the name of generated PK class for the current class.</p>
<h4><a name="pkClassForEjbJarXml">pkClassForEjbJarXml</a> (content template)</h4>
<p>Returns the name of PK class for the current class.</p>
<h4><a name="pkfieldList">pkfieldList</a> (content template)</h4>
<p>Returns a string containing comma-separated list of primary key fields with their types.</p>
<h4><a name="pkfieldListFrom">pkfieldListFrom</a> (content template)</h4>
<p>Returns a string containing comma-separated list of primary key fields getting from an object specified as parameter.</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
name
</i>
</td>
<td width="75%" valign="top">
The name of the variable to get the fields from.<br></br>
</td>
</tr>
</table>
<h4><a name="primkeyField">primkeyField</a> (content template)</h4>
<p>Returns the primkey-field defined for the current class.</p>
<h4><a name="primkeyGetter">primkeyGetter</a> (content template)</h4>
<p>Returns the getter name for the primkey-field.</p>
<h4><a name="primkeySetter">primkeySetter</a> (content template)</h4>
<p>Returns the setter name for the primkey-field.</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>
