|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface EntityBeanType
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 - an optional mapped-name element that can be used to provide vendor-specific deployment information such as the physical jndi-name of the entity bean's remote home interface. This element is not required to be supported by all implementations. Any use of this element is non-portable. - 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 optional entity bean's persistence management type. If this element is not specified it is defaulted to Container. - 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.
Java class for entity-beanType complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="entity-beanType">
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
<group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
<element name="ejb-name" type="{http://java.sun.com/xml/ns/javaee}ejb-nameType"/>
<element name="mapped-name" type="{http://java.sun.com/xml/ns/javaee}xsdStringType" minOccurs="0"/>
<element name="home" type="{http://java.sun.com/xml/ns/javaee}homeType" minOccurs="0"/>
<element name="remote" type="{http://java.sun.com/xml/ns/javaee}remoteType" minOccurs="0"/>
<element name="local-home" type="{http://java.sun.com/xml/ns/javaee}local-homeType" minOccurs="0"/>
<element name="local" type="{http://java.sun.com/xml/ns/javaee}localType" minOccurs="0"/>
<element name="ejb-class" type="{http://java.sun.com/xml/ns/javaee}ejb-classType"/>
<element name="persistence-type" type="{http://java.sun.com/xml/ns/javaee}persistence-typeType"/>
<element name="prim-key-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
<element name="reentrant" type="{http://java.sun.com/xml/ns/javaee}true-falseType"/>
<element name="cmp-version" type="{http://java.sun.com/xml/ns/javaee}cmp-versionType" minOccurs="0"/>
<element name="abstract-schema-name" type="{http://java.sun.com/xml/ns/javaee}java-identifierType" minOccurs="0"/>
<element name="cmp-field" type="{http://java.sun.com/xml/ns/javaee}cmp-fieldType" maxOccurs="unbounded" minOccurs="0"/>
<element name="primkey-field" type="{http://java.sun.com/xml/ns/javaee}string" minOccurs="0"/>
<group ref="{http://java.sun.com/xml/ns/javaee}jndiEnvironmentRefsGroup"/>
<element name="security-role-ref" type="{http://java.sun.com/xml/ns/javaee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
<element name="security-identity" type="{http://java.sun.com/xml/ns/javaee}security-identityType" minOccurs="0"/>
<element name="query" type="{http://java.sun.com/xml/ns/javaee}queryType" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
<attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
</restriction>
</complexContent>
</complexType>
| Method Summary | |
|---|---|
JavaIdentifierType |
getAbstractSchemaName()
Gets the value of the abstractSchemaName property. |
List<CmpFieldType> |
getCmpField()
Gets the value of the cmpField property. |
CmpVersionType |
getCmpVersion()
Gets the value of the cmpVersion property. |
List<DescriptionType> |
getDescription()
Gets the value of the description property. |
List<DisplayNameType> |
getDisplayName()
Gets the value of the displayName property. |
EjbClassType |
getEjbClass()
Gets the value of the ejbClass property. |
List<EjbLocalRefType> |
getEjbLocalRef()
Gets the value of the ejbLocalRef property. |
EjbNameType |
getEjbName()
Gets the value of the ejbName property. |
List<EjbRefType> |
getEjbRef()
Gets the value of the ejbRef property. |
List<EnvEntryType> |
getEnvEntry()
Gets the value of the envEntry property. |
HomeType |
getHome()
Gets the value of the home property. |
List<IconType> |
getIcon()
Gets the value of the icon property. |
String |
getId()
Gets the value of the id property. |
LocalType |
getLocal()
Gets the value of the local property. |
LocalHomeType |
getLocalHome()
Gets the value of the localHome property. |
XsdStringType |
getMappedName()
Gets the value of the mappedName property. |
List<MessageDestinationRefType> |
getMessageDestinationRef()
Gets the value of the messageDestinationRef property. |
List<PersistenceContextRefType> |
getPersistenceContextRef()
Gets the value of the persistenceContextRef property. |
PersistenceTypeType |
getPersistenceType()
Gets the value of the persistenceType property. |
List<PersistenceUnitRefType> |
getPersistenceUnitRef()
Gets the value of the persistenceUnitRef property. |
List<LifecycleCallbackType> |
getPostConstruct()
Gets the value of the postConstruct property. |
List<LifecycleCallbackType> |
getPreDestroy()
Gets the value of the preDestroy property. |
FullyQualifiedClassType |
getPrimKeyClass()
Gets the value of the primKeyClass property. |
String |
getPrimkeyField()
Gets the value of the primkeyField property. |
List<QueryType> |
getQuery()
Gets the value of the query property. |
TrueFalseType |
getReentrant()
Gets the value of the reentrant property. |
RemoteType |
getRemote()
Gets the value of the remote property. |
List<ResourceEnvRefType> |
getResourceEnvRef()
Gets the value of the resourceEnvRef property. |
List<ResourceRefType> |
getResourceRef()
Gets the value of the resourceRef property. |
SecurityIdentityType |
getSecurityIdentity()
Gets the value of the securityIdentity property. |
List<SecurityRoleRefType> |
getSecurityRoleRef()
Gets the value of the securityRoleRef property. |
List<ServiceRefType> |
getServiceRef()
Gets the value of the serviceRef property. |
void |
setAbstractSchemaName(JavaIdentifierType value)
Sets the value of the abstractSchemaName property. |
void |
setCmpVersion(CmpVersionType value)
Sets the value of the cmpVersion property. |
void |
setEjbClass(EjbClassType value)
Sets the value of the ejbClass property. |
void |
setEjbName(EjbNameType value)
Sets the value of the ejbName property. |
void |
setHome(HomeType value)
Sets the value of the home property. |
void |
setId(String value)
Sets the value of the id property. |
void |
setLocal(LocalType value)
Sets the value of the local property. |
void |
setLocalHome(LocalHomeType value)
Sets the value of the localHome property. |
void |
setMappedName(XsdStringType value)
Sets the value of the mappedName property. |
void |
setPersistenceType(PersistenceTypeType value)
Sets the value of the persistenceType property. |
void |
setPrimKeyClass(FullyQualifiedClassType value)
Sets the value of the primKeyClass property. |
void |
setPrimkeyField(String value)
Sets the value of the primkeyField property. |
void |
setReentrant(TrueFalseType value)
Sets the value of the reentrant property. |
void |
setRemote(RemoteType value)
Sets the value of the remote property. |
void |
setSecurityIdentity(SecurityIdentityType value)
Sets the value of the securityIdentity property. |
| Method Detail |
|---|
List<DescriptionType> getDescription()
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 description property.
For example, to add a new item, do as follows:
getDescription().add(newItem);
Objects of the following type(s) are allowed in the list
DescriptionType
List<DisplayNameType> getDisplayName()
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 displayName property.
For example, to add a new item, do as follows:
getDisplayName().add(newItem);
Objects of the following type(s) are allowed in the list
DisplayNameType
List<IconType> getIcon()
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 icon property.
For example, to add a new item, do as follows:
getIcon().add(newItem);
Objects of the following type(s) are allowed in the list
IconType
EjbNameType getEjbName()
EjbNameTypevoid setEjbName(EjbNameType value)
value - allowed object is
EjbNameTypeXsdStringType getMappedName()
XsdStringTypevoid setMappedName(XsdStringType value)
value - allowed object is
XsdStringTypeHomeType getHome()
HomeTypevoid setHome(HomeType value)
value - allowed object is
HomeTypeRemoteType getRemote()
RemoteTypevoid setRemote(RemoteType value)
value - allowed object is
RemoteTypeLocalHomeType getLocalHome()
LocalHomeTypevoid setLocalHome(LocalHomeType value)
value - allowed object is
LocalHomeTypeLocalType getLocal()
LocalTypevoid setLocal(LocalType value)
value - allowed object is
LocalTypeEjbClassType getEjbClass()
EjbClassTypevoid setEjbClass(EjbClassType value)
value - allowed object is
EjbClassTypePersistenceTypeType getPersistenceType()
PersistenceTypeTypevoid setPersistenceType(PersistenceTypeType value)
value - allowed object is
PersistenceTypeTypeFullyQualifiedClassType getPrimKeyClass()
FullyQualifiedClassTypevoid setPrimKeyClass(FullyQualifiedClassType value)
value - allowed object is
FullyQualifiedClassTypeTrueFalseType getReentrant()
TrueFalseTypevoid setReentrant(TrueFalseType value)
value - allowed object is
TrueFalseTypeCmpVersionType getCmpVersion()
CmpVersionTypevoid setCmpVersion(CmpVersionType value)
value - allowed object is
CmpVersionTypeJavaIdentifierType getAbstractSchemaName()
JavaIdentifierTypevoid setAbstractSchemaName(JavaIdentifierType value)
value - allowed object is
JavaIdentifierTypeList<CmpFieldType> getCmpField()
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 cmpField property.
For example, to add a new item, do as follows:
getCmpField().add(newItem);
Objects of the following type(s) are allowed in the list
CmpFieldType
String getPrimkeyField()
Stringvoid setPrimkeyField(String value)
value - allowed object is
StringList<EnvEntryType> getEnvEntry()
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 envEntry property.
For example, to add a new item, do as follows:
getEnvEntry().add(newItem);
Objects of the following type(s) are allowed in the list
EnvEntryType
List<EjbRefType> getEjbRef()
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 ejbRef property.
For example, to add a new item, do as follows:
getEjbRef().add(newItem);
Objects of the following type(s) are allowed in the list
EjbRefType
List<EjbLocalRefType> getEjbLocalRef()
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 ejbLocalRef property.
For example, to add a new item, do as follows:
getEjbLocalRef().add(newItem);
Objects of the following type(s) are allowed in the list
EjbLocalRefType
List<ServiceRefType> getServiceRef()
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 serviceRef property.
For example, to add a new item, do as follows:
getServiceRef().add(newItem);
Objects of the following type(s) are allowed in the list
ServiceRefType
List<ResourceRefType> getResourceRef()
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 resourceRef property.
For example, to add a new item, do as follows:
getResourceRef().add(newItem);
Objects of the following type(s) are allowed in the list
ResourceRefType
List<ResourceEnvRefType> getResourceEnvRef()
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 resourceEnvRef property.
For example, to add a new item, do as follows:
getResourceEnvRef().add(newItem);
Objects of the following type(s) are allowed in the list
ResourceEnvRefType
List<MessageDestinationRefType> getMessageDestinationRef()
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 messageDestinationRef property.
For example, to add a new item, do as follows:
getMessageDestinationRef().add(newItem);
Objects of the following type(s) are allowed in the list
MessageDestinationRefType
List<PersistenceContextRefType> getPersistenceContextRef()
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 persistenceContextRef property.
For example, to add a new item, do as follows:
getPersistenceContextRef().add(newItem);
Objects of the following type(s) are allowed in the list
PersistenceContextRefType
List<PersistenceUnitRefType> getPersistenceUnitRef()
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 persistenceUnitRef property.
For example, to add a new item, do as follows:
getPersistenceUnitRef().add(newItem);
Objects of the following type(s) are allowed in the list
PersistenceUnitRefType
List<LifecycleCallbackType> getPostConstruct()
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 postConstruct property.
For example, to add a new item, do as follows:
getPostConstruct().add(newItem);
Objects of the following type(s) are allowed in the list
LifecycleCallbackType
List<LifecycleCallbackType> getPreDestroy()
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 preDestroy property.
For example, to add a new item, do as follows:
getPreDestroy().add(newItem);
Objects of the following type(s) are allowed in the list
LifecycleCallbackType
List<SecurityRoleRefType> getSecurityRoleRef()
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 securityRoleRef property.
For example, to add a new item, do as follows:
getSecurityRoleRef().add(newItem);
Objects of the following type(s) are allowed in the list
SecurityRoleRefType
SecurityIdentityType getSecurityIdentity()
SecurityIdentityTypevoid setSecurityIdentity(SecurityIdentityType value)
value - allowed object is
SecurityIdentityTypeList<QueryType> getQuery()
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 query property.
For example, to add a new item, do as follows:
getQuery().add(newItem);
Objects of the following type(s) are allowed in the list
QueryType
String getId()
Stringvoid setId(String value)
value - allowed object is
String
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||