complexType entity-beanType

complexType {http://java.sun.com/xml/ns/j2ee}entity-beanType

Abstractfalse (This can be used in an instance)
Target Namespacehttp://java.sun.com/xml/ns/j2ee
Declared Namespacesxmlns:xsd=http://www.w3.org/2001/XMLSchema
xmlns:j2ee=http://java.sun.com/xml/ns/j2ee
xmlns=http://www.w3.org/2001/XMLSchema


Source

<xsd:complexType name="entity-beanType">
    <
xsd:annotation>
        <
xsd:documentation>
The entity-beanType declares an entity bean. The declaration
consists of:

- an optional description
- an optional display name
- an optional icon element that contains a small and a large
icon file name
- a unique name assigned to the enterprise bean
in the deployment descriptor
- the names of the entity bean's remote home
and remote interfaces, if any
- the names of the entity bean's local home and local
interfaces, if any
- the entity bean's implementation class
- the entity bean's persistence management type
- the entity bean's primary key class name
- an indication of the entity bean's reentrancy
- an optional specification of the
entity bean's cmp-version
- an optional specification of the entity bean's
abstract schema name
- an optional list of container-managed fields
- an optional specification of the primary key
field
- an optional declaration of the bean's environment
entries
- an optional declaration of the bean's EJB
references
- an optional declaration of the bean's local
EJB references
- an optional declaration of the bean's web
service references
- an optional declaration of the security role
references
- an optional declaration of the security identity
to be used for the execution of the bean's methods
- an optional declaration of the bean's
resource manager connection factory references
- an optional declaration of the bean's
resource environment references
- an optional declaration of the bean's message
destination references
- an optional set of query declarations
for finder and select methods for an entity
bean with cmp-version 2.x.

The optional abstract-schema-name element must be specified
for an entity bean with container-managed persistence and
cmp-version 2.x.

The optional primkey-field may be present in the descriptor
if the entity's persistence-type is Container.

The optional cmp-version element may be present in the
descriptor if the entity's persistence-type is Container. If
the persistence-type is Container and the cmp-version
element is not specified, its value defaults to 2.x.

The optional home and remote elements must be specified if
the entity bean cmp-version is 1.x.

The optional home and remote elements must be specified if
the entity bean has a remote home and remote interface.

The optional local-home and local elements must be specified
if the entity bean has a local home and local interface.

Either both the local-home and the local elements or both
the home and the remote elements must be specified.

The optional query elements must be present if the
persistence-type is Container and the cmp-version is 2.x and
query methods other than findByPrimaryKey have been defined
for the entity bean.

The other elements that are optional are "optional" in the
sense that they are omitted if the lists represented by them
are empty.

At least one cmp-field element must be present in the
descriptor if the entity's persistence-type is Container and
the cmp-version is 1.x, and none must not be present if the
entity's persistence-type is Bean.
        
</xsd:documentation>
    </
xsd:annotation>
    <
xsd:sequence>
        <
xsd:group ref="j2ee:descriptionGroup"/>
        <
xsd:element name="ejb-name" type="j2ee:ejb-nameType"/>
        <
xsd:element name="home" type="j2ee:homeType" minOccurs="0"/>
        <
xsd:element name="remote" type="j2ee:remoteType" minOccurs="0"/>
        <
xsd:element name="local-home" type="j2ee:local-homeType" minOccurs="0"/>
        <
xsd:element name="local" type="j2ee:localType" minOccurs="0"/>
        <
xsd:element name="ejb-class" type="j2ee:ejb-classType"/>
        <
xsd:element name="persistence-type" type="j2ee:persistence-typeType"/>
        <
xsd:element name="prim-key-class" type="j2ee:fully-qualified-classType">
            <
xsd:annotation>
                <
xsd:documentation>
The prim-key-class element contains the
fully-qualified name of an
entity bean's primary key class.

If the definition of the primary key class is
deferred to deployment time, the prim-key-class
element should specify java.lang.Object.
                
</xsd:documentation>
            </
xsd:annotation>
        </
xsd:element>
        <
xsd:element name="reentrant" type="j2ee:true-falseType">
            <
xsd:annotation>
                <
xsd:documentation>
The reentrant element specifies whether an entity
bean is reentrant or not.

The reentrant element must be one of the two
following: true or false
                
</xsd:documentation>
            </
xsd:annotation>
        </
xsd:element>
        <
xsd:element name="cmp-version" type="j2ee:cmp-versionType" minOccurs="0"/>
        <
xsd:element name="abstract-schema-name" type="j2ee:java-identifierType" minOccurs="0">
            <
xsd:annotation>
                <
xsd:documentation>
The abstract-schema-name element specifies the name
of the abstract schema type of an entity bean with
cmp-version 2.x. It is used in EJB QL queries.

For example, the abstract-schema-name for an entity
bean whose local interface is
com.acme.commerce.Order might be Order.
                
</xsd:documentation>
            </
xsd:annotation>
        </
xsd:element>
        <
xsd:element name="cmp-field" type="j2ee:cmp-fieldType" minOccurs="0" maxOccurs="unbounded"/>
        <
xsd:element name="primkey-field" type="j2ee:string" minOccurs="0">
            <
xsd:annotation>
                <
xsd:documentation>
The primkey-field element is used to specify the
name of the primary key field for an entity with
container-managed persistence.

The primkey-field must be one of the fields declared
in the cmp-field element, and the type of the field
must be the same as the primary key type.

The primkey-field element is not used if the primary
key maps to multiple container-managed fields
(i.e. the key is a compound key). In this case, the
fields of the primary key class must be public, and
their names must correspond to the field names of
the entity bean class that comprise the key.
                
</xsd:documentation>
            </
xsd:annotation>
        </
xsd:element>
        <
xsd:group ref="j2ee:jndiEnvironmentRefsGroup"/>
        <
xsd:element name="security-role-ref" type="j2ee:security-role-refType" minOccurs="0"
            
maxOccurs="unbounded"/>
        <
xsd:element name="security-identity" type="j2ee:security-identityType" minOccurs="0"/>
        <
xsd:element name="query" type="j2ee:queryType" minOccurs="0" maxOccurs="unbounded"/>
    </
xsd:sequence>
    <
xsd:attribute name="id" type="xsd:ID"/>
</
xsd:complexType>


Documentation

	The entity-beanType declares an entity bean. The declaration
	consists of:
	    - an optional description
	    - an optional display name
	    - an optional icon element that contains a small and a large
	      icon file name
	    - a unique name assigned to the enterprise bean
	      in the deployment descriptor
	    - the names of the entity bean's remote home
	      and remote interfaces, if any
	    - the names of the entity bean's local home and local
	      interfaces, if any
	    - the entity bean's implementation class
	    - the entity bean's persistence management type
	    - the entity bean's primary key class name
	    - an indication of the entity bean's reentrancy
	    - an optional specification of the
	      entity bean's cmp-version
	    - an optional specification of the entity bean's
	      abstract schema name
	    - an optional list of container-managed fields
	    - an optional specification of the primary key
	      field
	    - an optional declaration of the bean's environment
	      entries
	    - an optional declaration of the bean's EJB
	      references
	    - an optional declaration of the bean's local
	      EJB references
	    - an optional declaration of the bean's web
	      service references
	    - an optional declaration of the security role
	      references
	    - an optional declaration of the security identity
	      to be used for the execution of the bean's methods
	    - an optional declaration of the bean's
	      resource manager connection factory references
	    - an optional declaration of the bean's
	      resource environment references
	    - an optional declaration of the bean's message
	      destination references
	    - an optional set of query declarations
	      for finder and select methods for an entity
	      bean with cmp-version 2.x.
	The optional abstract-schema-name element must be specified
	for an entity bean with container-managed persistence and
	cmp-version 2.x.
	The optional primkey-field may be present in the descriptor
	if the entity's persistence-type is Container.
	The optional cmp-version element may be present in the
	descriptor if the entity's persistence-type is Container. If
	the persistence-type is Container and the cmp-version
	element is not specified, its value defaults to 2.x.
	The optional home and remote elements must be specified if
	the entity bean cmp-version is 1.x.
	The optional home and remote elements must be specified if
	the entity bean has a remote home and remote interface.
	The optional local-home and local elements must be specified
	if the entity bean has a local home and local interface.
	Either both the local-home and the local elements or both
	the home and the remote elements must be specified.
	The optional query elements must be present if the
	persistence-type is Container and the cmp-version is 2.x and
	query methods other than findByPrimaryKey have been defined
	for the entity bean.
	The other elements that are optional are "optional" in the
	sense that they are omitted if the lists represented by them
	are empty.
	At least one cmp-field element must be present in the
	descriptor if the entity's persistence-type is Container and
	the cmp-version is 1.x, and none must not be present if the
	entity's persistence-type is Bean.


complexType entity-beanType


Stylus Studio XML Schema Library Home
Site Map | Privacy Policy | Terms of Use | Trademarks
Stylus Scoop XML Newsletter:
W3C Member
Stylus Studio®, a product from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2006 All Rights Reserved.