Sophie

Sophie

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

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


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

<h2>EjbFacade</h2>

<p>Implemented in class <a href="../api/xdoclet/modules/ejb/entity/FacadeTagsHandler.html">xdoclet.modules.ejb.entity.FacadeTagsHandler</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="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="ifEntity">ifEntity</a> (block template)</h4>
<p>Evaluate the body block if current class is of an entity type.</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="ifRemoteEjb">ifRemoteEjb</a> (block template)</h4>
<p></p>

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

<h4><a name="ifUseLocalInterface">ifUseLocalInterface</a> (block template)</h4>
<p>decide whether we have to use local interface of the bean</p>

<h4><a name="ifUseRemoteInterface">ifUseRemoteInterface</a> (block template)</h4>
<p>decide whether we have to use remote interface of the bean</p>

<h3><a name="content">Content templates:</a></h3>

<h4><a name="beanPermission">beanPermission</a> (content template)</h4>
<p>generate permission spec - inherit from bean</p>

<h4><a name="beanRef">beanRef</a> (content template)</h4>
<p>generate bean reference</p>

<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="entityFacadeClass">entityFacadeClass</a> (content template)</h4>
<p>produce class name for ejb facade</p>

<h4><a name="facadeEjbName">facadeEjbName</a> (content template)</h4>
<p>prodice facade ejb name. Default would be</p>

<h4><a name="id">id</a> (content template)</h4>
<p>Returns unique id for current ejb.</p>

<h4><a name="jndiName">jndiName</a> (content template)</h4>
<p>jndi name if any or default</p>

<h4><a name="localJndiName">localJndiName</a> (content template)</h4>
<p>local jndi name if any</p>

<h4><a name="persistenceType">persistenceType</a> (content template)</h4>
<p>Returns the persistent type of current bean.</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="remoteFacadeClass">remoteFacadeClass</a> (content template)</h4>
<p></p>

<h4><a name="sessionType">sessionType</a> (content template)</h4>
<p>provide session type</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>

<h4><a name="viewType">viewType</a> (content template)</h4>
<p>provide view type for facade bean - inherit from class if not specified</p>

</body>
</html>