## EjbHome

Implemented in class xdoclet.modules.ejb.home.HomeTagsHandler.

- Block Tags
- Content Tags

### Block Tags:

#### ifIsCreateMethod (block template)

Evaluates the body block if current method is a create method. Create methods should have ejb:create-method defined.

[superclasses] | Traverse superclasses too. With false value used in remote/local home interface templates. Default is False.

#### ifDoesntHavePostCreateMethod (block template)

Evaluates the body block if current create method's ejbPostCreate method does not exist.

#### ifIsHomeMethod (block template)

Evaluates the body block if current method is a home method. Home methods should have ejb:home-method defined.

[superclasses] | Traverse superclasses too. With false value used in remote/local home interface templates. Default is False.

#### ifNotRemoveMethod (block template)

Evaluates the body block if current method is not an ejbRemove method.

#### ifIsFinderMethod (block template)

Evaluates the body block if current method is a ejbFind method.

[superclasses] | Traverse superclasses too. With false value used in remote/local home interface templates. Default is False.

#### forAllHomeMethods (block template)

Iterates over all home methods of specified type (finder or create method) defined in a class and super classes.

tagName | The tag name for the method type to iterate over. Valid Values = {ejb:finder,ejb:create-method}
[superclasses] | If true then traverse superclasses also, otherwise look up the tag in current concrete class only. Valid Values = {true,false}
[tagKey] | A tag property that will be used as a unique key. This is used to avoid duplicate code due to similar tags in superclasses.

#### ifIsCollectionType (block template)

Whether current finder return collection.

#### ifIsEnumerationType (block template)

Whether current finder return enumeration.

#### ifIsInterfaceType (block template)

Whether current finder return interface.

#### forAllBeans (block template)

Evaluates the body block for each EJBean derived from one of the three EJB types: EntityBean, SessionBean or MessageDrivenBean.

#### ifIsAConcreteEJBean (block template)

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.

#### ifLocalEjb (block template)

#### ifRemoteEjb (block template)

#### ifServiceEndpointEjb (block template)

#### ifNotLocalEjb (block template)

#### ifNotRemoteEjb (block template)

#### ifNotServiceEndpointEjb (block template)

### Content templates:

#### homeInterface (content template)

Returns the full qualified local or remote home interface name for the bean, depending on the value of type parameter.

type | Specifies the type of component home interface. Valid Values = {remote,local}

#### ejbPostCreateSignature (content template)

Returns the appropriate ejbPostCreate method name for the current ejbCreate method.

#### compName (content template)

[prefixWithEjbSlash] | Specifies whether to prefix it with ejb/ or not. False by default. Valid Values = {true,false}
type | Specifies if we want the jndi name value for local or remote lookup. Valid Values = {remote,local}

#### jndiName (content template)

type | Specifies if we want the jndi name value for local or remote lookup. Valid Values = {remote,local}

#### extendsFrom (content template)

Returns the name of the class home interface extends.

#### currentPermission (content template)

Return permission for current home method.

#### currentType (content template)

Return type of current home method.

#### finderClass (content template)

generates name for finder utility class backing current finder

#### currentMethod (content template)

Return name of current home method.

#### parameterListDefinition (content template)

Return parameter list definition (types and names) for current home method.

#### parameterList (content template)

Return parameter list (names only) for current home method.

#### currentExceptions (content template)

Return exceptions for current home method.

#### ejbRefName (content template)

Returns the name of EJB ref.

#### ejbRefName (content template)

Returns the name of EJB ref.

#### ejbName (content template)

Returns the name of current EJB bean.

[prefixWithEjbSlash] | Specifies whether to prefix it with ejb/ or not. False by default. Valid Values = {true,false}

#### ejbExternalRefName (content template)

Returns the name of EJB ref.

#### symbolicClassName (content template)

Returns the symbolic name of the current class. For an EJBean it's the value of ejb:bean's name parameter.

#### shortEjbName (content template)

Returns short version of ejbName(). Example: "foo.bar.MyBean" ->"MyBean", "foo/bar/MyBean" ->"MyBean"

#### beanType (content template)

Returns Bean type : "Entity", "Session" or "Message Driven".

#### concreteFullClassName (content template)

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.

#### id (content template)

Returns unique id for current ejb.