org.eclipse.jst.j2ee.ejb
Interface Entity

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.ENamedElement, EnterpriseBean, org.eclipse.emf.ecore.EObject, J2EEEObject, JNDIEnvRefsGroup, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
ContainerManagedEntity

public interface Entity
extends EnterpriseBean

The entity element declares an entity bean. The declaration consists of: an optional description; optional display name; optional small icon file name; optional large icon file name; a unique name assigned to the enterprise bean in the deployment descriptor; the names of the entity bean's home and remote interfaces, if any; the names of the entity bean's local home and local interface, 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 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 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 local-home and local elements must be specified if the entity bean has a local home and local interface. 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.

Since:
1.0

Method Summary
 JavaClass getPrimaryKey()
           
 java.lang.String getPrimaryKeyName()
           
 boolean isContainerManagedEntity()
           
 boolean isReentrant()
           
 boolean isSetReentrant()
          Returns whether the value of the 'Reentrant' attribute is set
 void setPrimaryKey(JavaClass value)
           
 void setPrimaryKeyName(java.lang.String primaryKeyName)
           
 void setReentrant(boolean value)
          Sets the value of the 'Reentrant' attribute
 void unsetReentrant()
          Unsets the value of the 'Reentrant' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.ejb.EnterpriseBean
createMethodElements, getAvailableCommonMethodElements, getAvailableCommonMethodElementSignatures, getAvailableHomeMethodElements, getAvailableLocalHomeMethodElements, getAvailableLocalMethodElements, getAvailableRemoteMethodElements, getAvailableUnspecifiedMethodElements, getAvailableUnspecifiedMethodElementSignatures, getEjbClass, getEjbClassName, getEjbJar, getEquivalentEJBLocalRef, getEquivalentEjbRef, getExistingOrAvailableMethodElements, getExistingOrAvailableMethodElements, getHomeInterface, getHomeInterfaceName, getHomeMethodsForDeployment, getLinkedEJBLocalReference, getLinkedEJBReference, getLocalHomeInterface, getLocalHomeInterfaceName, getLocalHomeMethodsForDeployment, getLocalInterface, getLocalInterfaceName, getName, getRemoteInterface, getRemoteInterfaceName, getRemoteMethodsForDeployment, getSecurityIdentity, getSecurityRoleRefs, getVersionID, hasJavaReference, hasLocalClient, hasRemoteClient, isBeanManagedEntity, isEntity, isMessageDriven, isSession, isVersion1_X, isVersion2_X, reSyncSecurityRoleRef, setEjbClass, setEjbClassName, setEjbJar, setHomeInterface, setHomeInterfaceName, setLocalHomeInterface, setLocalHomeInterfaceName, setLocalInterface, setLocalInterfaceName, setName, setRemoteInterface, setRemoteInterfaceName, setSecurityIdentity
 
Methods inherited from interface org.eclipse.jst.j2ee.common.JNDIEnvRefsGroup
getEjbLocalRefs, getEjbRefs, getEnvironmentProperties, getMessageDestinationRefs, getResourceEnvRefs, getResourceRefs, getServiceRefs
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 

Method Detail

getPrimaryKeyName

java.lang.String getPrimaryKeyName()

isContainerManagedEntity

boolean isContainerManagedEntity()
Specified by:
isContainerManagedEntity in interface EnterpriseBean

setPrimaryKeyName

void setPrimaryKeyName(java.lang.String primaryKeyName)

isReentrant

boolean isReentrant()
Returns:
The value of the IsReentrant attribute The reentrant element specifies whether an entity bean is reentrant or not.

setReentrant

void setReentrant(boolean value)
Sets the value of the 'Reentrant' attribute.

Parameters:
value - the new value of the 'Reentrant' attribute.
See Also:
isSetReentrant(), unsetReentrant(), isReentrant()

unsetReentrant

void unsetReentrant()
Unsets the value of the 'Reentrant' attribute.

See Also:
isSetReentrant(), isReentrant(), setReentrant(boolean)

isSetReentrant

boolean isSetReentrant()
Returns whether the value of the 'Reentrant' attribute is set.

Returns:
whether the value of the 'Reentrant' attribute is set.
See Also:
unsetReentrant(), isReentrant(), setReentrant(boolean)

getPrimaryKey

JavaClass getPrimaryKey()
Returns:
The PrimaryKey reference 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. Examples:java.lang.String com.wombat.empl.EmployeeID java.lang.Object

setPrimaryKey

void setPrimaryKey(JavaClass value)
Parameters:
l - The new value of the PrimaryKey reference