MethodElement

MethodElement

This type is a class for model objects.

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
Package: ejb

Known subtypes:
    QueryMethod

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Collection attributes having this type:
  AccessIntent.methodElements
  AppliedAccessIntent.methodElements
  CompensationEJBMethodPolicy.methodElements
  ContainerActivitySession.methodElement
  ContainerActivitySession.methodElements
  ExcludeList.methodElements
  FinderDescriptor.finderMethodElements
  I18NEJBContainerInternationalization.methodElements
  IsolationLevelAttributes.methodElements
  MethodPermission.methodElements
  MethodTransaction.methodElements
  RunAsTask.methodElements
  SecurityIdentity.methodElements

Attributes Summary

name : EString The method-name element contains a name of an enterprise bean method, or the asterisk (*) character. The asterisk is used when the element denotes all the methods of an enterprise bean's remote and home interfaces.

parms : EString The method-params element contains a list of the fully-qualified Java type names of the method parameters. In the current implementation this is a space delimitted String. A null string indicates a generic method element that can apply to multiple methods with the same name. An empty string indicates a method with zero parameters. In future implementations (post V5), this field will be deprecated and migrated to use the multi-valued params field and the isZeroParams flag.

type : MethodElementKind * No description is available *

description : EString @version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.

enterpriseBean : EnterpriseBean @ * No description is available *

descriptions : Description * * No description is available *

Attribute Details

name  -  The method-name element contains a name of an enterprise bean method, or the asterisk (*) character. The asterisk is used when the element denotes all the methods of an enterprise bean's remote and home interfaces.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

parms  -  The method-params element contains a list of the fully-qualified Java type names of the method parameters. In the current implementation this is a space delimitted String. A null string indicates a generic method element that can apply to multiple methods with the same name. An empty string indicates a method with zero parameters. In future implementations (post V5), this field will be deprecated and migrated to use the multi-valued params field and the isZeroParams flag.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

type  -  * No description is available *
    Data Type: MethodElementKind
    Default value:  unspecified
    Allowed values:
        0 - Unspecified
        1 - Remote
        2 - Home
        3 - Local
        4 - LocalHome
        5 - ServiceEndpoint
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

description  -  @version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enterpriseBean  -  * No description is available *
    Reference Type: EnterpriseBean @
    Containment:  false
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

descriptions  -  * No description is available *
    Reference Type: Description *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
name : EString	The method-name element contains a name of an enterprise bean method, or the asterisk (*) character. The asterisk is used when the element denotes all the methods of an enterprise bean's remote and home interfaces.
parms : EString	The method-params element contains a list of the fully-qualified Java type names of the method parameters. In the current implementation this is a space delimitted String. A null string indicates a generic method element that can apply to multiple methods with the same name. An empty string indicates a method with zero parameters. In future implementations (post V5), this field will be deprecated and migrated to use the multi-valued params field and the isZeroParams flag.
type : MethodElementKind	* No description is available *
description : EString	@version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.
enterpriseBean : EnterpriseBean @	* No description is available *
descriptions : Description *	* No description is available *