org.apache.openejb.jee.was.v6.ejb
Class MethodElement

java.lang.Object
  org.apache.openejb.jee.was.v6.ejb.MethodElement

Direct Known Subclasses:

QueryMethod

public class MethodElement
extends Object

The method element is used to denote a method of an enterprise bean's home or remote interface, or a set of methods. The ejb-name element must be the name of one of the enterprise beans in declared in the deployment descriptor; the optional method-intf element allows to distinguish between a method with the same signature that is defined in both the home and remote interface; the method-name element specifies the method name; and the optional method-params elements identify a

single method among multiple methods with an overloaded method name.

There are three possible styles of the method element syntax:

1.

EJBNAME

*

This style is used to refer to all the methods of the specified enterprise bean's home and remote interfaces.

2.

EJBNAME

METHOD

>

This style is used to refer to the specified method of the specified enterprise bean. If there are multiple methods with

the same overloaded name, the element of this style refers to all the methods with the overloaded name.

3.

EJBNAME

METHOD

PARAM-1

PARAM-2

...

PARAM-n

This style is used to refer to a single method within a set of methods with an overloaded name. PARAM-1 through PARAM-n are the fully-qualified Java types of the method's input parameters (if the method has no input arguments, the method-params element

contains no method-param elements). Arrays are specified by the array element's type, followed by one or more pair of square brackets (e.g. int[][]).

Used in: method-permission and container-transaction

Examples:

Style 1: The following method element refers to all the methods of the EmployeeService bean's home and remote interfaces:

EmployeeService

*

Style 2: The following method element refers to all the create methods of the EmployeeService bean's home interface:

EmployeeService

create

Style 3: The following method element refers to the create(String firstName, String LastName) method of the EmployeeService bean's home interface.

EmployeeService

create

java.lang.String

java.lang.String

The following example illustrates a Style 3 element with more complex parameter types. The method foobar(char s, int i, int[] iar, mypackage.MyClass mycl, mypackage.MyClass[][] myclaar)

would be specified as:

EmployeeService

foobar

char

int

int[]

mypackage.MyClass

mypackage.MyClass[][]

The optional method-intf element can be used when it becomes necessary to differentiate between a method defined in the home interface and a method with the same name and signature that is defined in the remote interface.

For example, the method element

EmployeeService

Remote

create

java.lang.String

java.lang.String

can be used to differentiate the create(String, String) method defined in the remote interface from the create(String, String) method defined in the home interface, which would be defined as

EmployeeService

Home

create

java.lang.String

java.lang.String

Java class for MethodElement complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="MethodElement">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="enterpriseBean" type="{ejb.xmi}EnterpriseBean"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="descriptions" type="{common.xmi}Description"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element ref="{http://www.omg.org/XMI}Extension"/>
         </choice>
       </choice>
       <attGroup ref="{http://www.omg.org/XMI}ObjectAttribs"/>
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="enterpriseBean" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="parms" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" type="{ejb.xmi}MethodElementKind" />
       <attribute ref="{http://www.omg.org/XMI}id"/>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected String	description
protected List<Description>	descriptions
protected String	enterpriseBean
protected List<EnterpriseBean>	enterpriseBeans
protected List<Extension>	extensions
protected String	href
protected String	id
protected Object	idref
protected String	label
protected MethodElementEnum	methodElementType
protected String	name
protected String	parms
protected QName	type
protected String	uuid
protected String	version

Constructor Summary

MethodElement()

Method Summary

String	getDescription() Gets the value of the description property.
List<Description>	getDescriptions() Gets the value of the descriptions property.
String	getEnterpriseBean() Gets the value of the enterpriseBean property.
List<EnterpriseBean>	getEnterpriseBeans() Gets the value of the enterpriseBeans property.
List<Extension>	getExtensions() Gets the value of the extensions property.
String	getHref() Gets the value of the href property.
String	getId() Gets the value of the id property.
Object	getIdref() Gets the value of the idref property.
String	getLabel() Gets the value of the label property.
MethodElementEnum	getMethodElementType() Gets the value of the methodElementType property.
String	getName() Gets the value of the name property.
String	getParms() Gets the value of the parms property.
QName	getType() Gets the value of the type property.
String	getUuid() Gets the value of the uuid property.
String	getVersion() Gets the value of the version property.
void	setDescription(String value) Sets the value of the description property.
void	setEnterpriseBean(String value) Sets the value of the enterpriseBean property.
void	setHref(String value) Sets the value of the href property.
void	setId(String value) Sets the value of the id property.
void	setIdref(Object value) Sets the value of the idref property.
void	setLabel(String value) Sets the value of the label property.
void	setMethodElementType(MethodElementEnum value) Sets the value of the methodElementType property.
void	setName(String value) Sets the value of the name property.
void	setParms(String value) Sets the value of the parms property.
void	setType(QName value) Sets the value of the type property.
void	setUuid(String value) Sets the value of the uuid property.
void	setVersion(String value) Sets the value of the version property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enterpriseBeans

protected List<EnterpriseBean> enterpriseBeans

descriptions

protected List<Description> descriptions

extensions

protected List<Extension> extensions

description

protected String description

enterpriseBean

protected String enterpriseBean

name

protected String name

parms

protected String parms

methodElementType

protected MethodElementEnum methodElementType

id

protected String id

type

protected QName type

version

protected String version

href

protected String href

idref

protected Object idref

label

protected String label

uuid

protected String uuid

Constructor Detail

MethodElement

public MethodElement()

Method Detail

getEnterpriseBeans

public List<EnterpriseBean> getEnterpriseBeans()

Gets the value of the enterpriseBeans property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the enterpriseBeans property.

For example, to add a new item, do as follows:

 getEnterpriseBeans().add(newItem);
 

Objects of the following type(s) are allowed in the list EnterpriseBean

getDescriptions

public List<Description> getDescriptions()

Gets the value of the descriptions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the descriptions property.

For example, to add a new item, do as follows:

 getDescriptions().add(newItem);
 

Objects of the following type(s) are allowed in the list Description

getExtensions

public List<Extension> getExtensions()

Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

 getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getEnterpriseBean

public String getEnterpriseBean()

Gets the value of the enterpriseBean property.

Returns:

possible object is String

setEnterpriseBean

public void setEnterpriseBean(String value)

Sets the value of the enterpriseBean property.

Parameters:

value - allowed object is String

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getParms

public String getParms()

Gets the value of the parms property.

Returns:

possible object is String

setParms

public void setParms(String value)

Sets the value of the parms property.

Parameters:

value - allowed object is String

getMethodElementType

public MethodElementEnum getMethodElementType()

Gets the value of the methodElementType property.

Returns:

possible object is MethodElementEnum

setMethodElementType

public void setMethodElementType(MethodElementEnum value)

Sets the value of the methodElementType property.

Parameters:

value - allowed object is MethodElementEnum

getId

public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

getType

public QName getType()

Gets the value of the type property.

Returns:

possible object is QName

setType

public void setType(QName value)

Sets the value of the type property.

Parameters:

value - allowed object is QName

getVersion

public String getVersion()

Gets the value of the version property.

Returns:

possible object is String

setVersion

public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String

getHref

public String getHref()

Gets the value of the href property.

Returns:

possible object is String

setHref

public void setHref(String value)

Sets the value of the href property.

Parameters:

value - allowed object is String

getIdref

public Object getIdref()

Gets the value of the idref property.

Returns:

possible object is Object

setIdref

public void setIdref(Object value)

Sets the value of the idref property.

Parameters:

value - allowed object is Object

getLabel

public String getLabel()

Gets the value of the label property.

Returns:

possible object is String

setLabel

public void setLabel(String value)

Sets the value of the label property.

Parameters:

value - allowed object is String

getUuid

public String getUuid()

Gets the value of the uuid property.

Returns:

possible object is String

setUuid

public void setUuid(String value)

Sets the value of the uuid property.

Parameters:

value - allowed object is String