<html>
<head>
</head>
<body bgcolor="#ffffff">
<h2>EjbValueObj</h2>
<p>Implemented in class <a href="../api/xdoclet/modules/ejb/entity/ValueObjectTagsHandler.html">xdoclet.modules.ejb.entity.ValueObjectTagsHandler</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="forAllAggregates">forAllAggregates</a> (block template)</h4>
<p>Loop over all the aggregate fields in the given value object, and generate the body for each one.</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">
Whether to include fields in superclasses.<br></br>
Valid Values = {true,false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
valueobject
</i>
</td>
<td width="75%" valign="top">
The value object name.<br></br>
</td>
</tr>
</table>
<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="forAllComposes">forAllComposes</a> (block template)</h4>
<p>Loop over all the composed fields in the given value object, and generate the body for each one.</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">
Whether to include fields in superclasses.<br></br>
Valid Values = {true,false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
valueobject
</i>
</td>
<td width="75%" valign="top">
The value object name.<br></br>
</td>
</tr>
</table>
<h4><a name="forAllRelations">forAllRelations</a> (block template)</h4>
<p>Loop over all the relation fields in the given value object, and generate the body for each one.</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">
Whether to include fields in superclasses.<br></br>
Valid Values = {true,false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
valueobject
</i>
</td>
<td width="75%" valign="top">
The value object name.<br></br>
</td>
</tr>
</table>
<h4><a name="forAllSuperSetValue">forAllSuperSetValue</a> (block template)</h4>
<p>Describe what the method does</p>
<h4><a name="forAllValueObjects">forAllValueObjects</a> (block template)</h4>
<p>Loops over all the ejb.value-object tags in the class, and generates the body for each one.</p>
<h4><a name="ifGeneratePKConstructor">ifGeneratePKConstructor</a> (block template)</h4>
<p>Evaluates the body if the <code>valueobject</code> subtask's <code>generatePKConstructor</code> parameter is <code>true</code>.</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="ifIsAbstractValueObject">ifIsAbstractValueObject</a> (block template)</h4>
<p>Evaluates the body if the <code>abstract</code> parameter is set to true on the ejb.value-object tag for the current VO.</p>
<h4><a name="ifIsCollection">ifIsCollection</a> (block template)</h4>
<p>Executes the body only if the current field is a collection.</p>
<h4><a name="ifIsNotCollection">ifIsNotCollection</a> (block template)</h4>
<p>Executes the body only if the current field is not a collection.</p>
<h4><a name="ifLocalEjb">ifLocalEjb</a> (block template)</h4>
<p></p>
<h4><a name="ifNotIsAbstractValueObject">ifNotIsAbstractValueObject</a> (block template)</h4>
<p>Evaluates the body if the <code>abstract</code> parameter is set to false (or is missing) on the ejb.value-object tag for the current VO.</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="ifUsingValueObject">ifUsingValueObject</a> (block template)</h4>
<p>Evaluate the body block if Value Object subtask being used.</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="collectionType">collectionType</a> (content template)</h4>
<p>Returns the collection type for the current field.</p>
<h4><a name="concreteCollectionType">concreteCollectionType</a> (content template)</h4>
<p>Type of the constructor for aggregates or compositions.</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="currentAggregateName">currentAggregateName</a> (content template)</h4>
<p>Returns the current aggregate's name</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
[plural]
</i>
</td>
<td width="75%" valign="top">
<br></br>
Valid Values = {true, false}
</td>
</tr>
<tr>
<td width="25%" valign="top">
<i>
[decapitalize]
</i>
</td>
<td width="75%" valign="top">
<br></br>
Valid Values = {true, false}
</td>
</tr>
</table>
<h4><a name="currentAggregateType">currentAggregateType</a> (content template)</h4>
<p>Returns the class name of the current aggregate attribute's type.</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
[short]
</i>
</td>
<td width="75%" valign="top">
Use the short (not fully-qualified) class name.<br></br>
</td>
</tr>
</table>
<h4><a name="currentRelationBeanClass">currentRelationBeanClass</a> (content template)</h4>
<p>Return the bean class name for the current relation.</p>
<h4><a name="currentValueObjectAttribute">currentValueObjectAttribute</a> (content template)</h4>
<p>Return the current value object's attribute name.</p>
<h4><a name="currentValueObjectClass">currentValueObjectClass</a> (content template)</h4>
<p>Return the current value object's class name.</p>
<h4><a name="currentValueObjectMatch">currentValueObjectMatch</a> (content template)</h4>
<p>Return the current value object's match parameter.</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 the specified value object extends. If no <code>extends</code> parameter exists on the <code>ejb.value-object</code> tag, <code>java.lang.Object</code> is returned.</p>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="25%" valign="top">
<i>
valueobject
</i>
</td>
<td width="75%" valign="top">
The name of the value object to check.<br></br>
</td>
</tr>
</table>
<h4><a name="id">id</a> (content template)</h4>
<p>Returns unique id for current ejb.</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="valueMostSuperObjectClass">valueMostSuperObjectClass</a> (content template)</h4>
<p>Returns the data-object class name highest in the hierarchy of derived beans. Because of possible inheritance between entity bean, the type of the generated getData method must be the one of the most super class of the current entity bean. The current Data class must extend the corresponding super Data class.</p>
<h4><a name="valueObjectClass">valueObjectClass</a> (content template)</h4>
<p>Return the current value object's class name.</p>
<h4><a name="valueObjectImplements">valueObjectImplements</a> (content template)</h4>
<p>return interfaces to be implemented</p>
<h4><a name="valueObjectMatch">valueObjectMatch</a> (content template)</h4>
<p>Return the current value object's match parameter.</p>
<h4><a name="valueObjectName">valueObjectName</a> (content template)</h4>
<p>Return the current value object's name.</p>
</body>
</html>
