Sophie

Sophie

distrib > Mandriva > 2010.0 > x86_64 > media > main-release > by-pkgid > 3b947bdd5e0f96306962f8c5b04dc08f > files > 119

xdoclet-manual-1.2.3-8.0.3mdv2010.0.noarch.rpm


<html>
<head>
</head>
<body bgcolor="#ffffff">

<h2>ResinEjb</h2>

<p>Implemented in class <a href="../api/xdoclet/modules/caucho/ResinEjbTagsHandler.html">xdoclet.modules.caucho.ResinEjbTagsHandler</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="forAllRelationships">forAllRelationships</a> (block template)</h4>
<p>Evaluates the body block for each relationship. Relations are denoted by ejb:relation for the getter method of the cmr-field.</p>

<h4><a name="ifHasLeftOrderBy">ifHasLeftOrderBy</a> (block template)</h4>
<p>Evaluates the body if the left side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.</p>

<h4><a name="ifHasLeftSqlColumn">ifHasLeftSqlColumn</a> (block template)</h4>
<p>Evaluates the body if the left side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.</p>

<h4><a name="ifHasRightOrderBy">ifHasRightOrderBy</a> (block template)</h4>
<p>Evaluates the body if the right side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.</p>

<h4><a name="ifHasRightSqlColumn">ifHasRightSqlColumn</a> (block template)</h4>
<p>Evaluates the body if the right side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.</p>

<h4><a name="ifHasSqlTable">ifHasSqlTable</a> (block template)</h4>
<p>Evaluates the body if either side of the current relation is many and the sql-table parameter of the resinejb:relation method-level tag is defined.</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="ifIsMany2Many">ifIsMany2Many</a> (block template)</h4>
<p>Evaluates the body block if the current relationship is a many to many type, meaning, both sides of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifIsNotACollection">ifIsNotACollection</a> (block template)</h4>
<p>Evaluates the body block if current method's return type is not a java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifIsOne2Many">ifIsOne2Many</a> (block template)</h4>
<p>Evaluates the body block if the current relationship is a one to many type, meaning, ONLY ONE side of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifIsOne2One">ifIsOne2One</a> (block template)</h4>
<p>Evaluates the body block if the current relationship is a one to one type, meaning, neither side of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifLocalEjb">ifLocalEjb</a> (block template)</h4>
<p></p>

<h4><a name="ifNotIsMany2Many">ifNotIsMany2Many</a> (block template)</h4>
<p>Evaluates the body block if the current relationship IS NOT a many to many type, meaning, at least one side of the relation does not return java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifNotIsOne2Many">ifNotIsOne2Many</a> (block template)</h4>
<p>Evaluates the body block if the current relationship IS NOT a one to many type, meaning, either both sides, or neither side of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.</p>

<h4><a name="ifNotIsOne2One">ifNotIsOne2One</a> (block template)</h4>
<p>Evaluates the body block if the current relationship IS NOT a one to one type, meaning, at least one side of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.</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="id">id</a> (content template)</h4>
<p>Returns unique id for current ejb.</p>

<h4><a name="leftOrderBy">leftOrderBy</a> (content template)</h4>
<p>Returns the order-by for the left side of the current relation, if applicable.</p>

<h4><a name="leftSqlColumn">leftSqlColumn</a> (content template)</h4>
<p>Returns the sql-column for the left side of the current relation, if applicable.</p>

<h4><a name="rightOrderBy">rightOrderBy</a> (content template)</h4>
<p>Returns the order-by for the right side of the current relation, if applicable.</p>

<h4><a name="rightSqlColumn">rightSqlColumn</a> (content template)</h4>
<p>Returns the sql-column for the right side of the current relation, if applicable.</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="signatureFromMethod">signatureFromMethod</a> (content template)</h4>
<p>Returns the signature of the current method in a form suitable for the /resinejb/enterprise-beans/entity/method/signature element.</p>

<h4><a name="sqlTable">sqlTable</a> (content template)</h4>
<p>Returns the sql-table of the current relationship, if any.</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>