org.eclipse.jst.j2ee.ejb
Interface EnterpriseBean

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

public interface EnterpriseBean
extends JNDIEnvRefsGroup, org.eclipse.emf.ecore.ENamedElement

Since:
1.0

Method Summary
 java.util.List createMethodElements(java.util.List someMethods, JavaClass anInterface)
          Creates a List of MethodElements that represent the Methods from @someMethods pointing to this EJB.
 java.util.List getAvailableCommonMethodElements()
          Deprecated. used getAvailableUnspecifiedMethodElements
 java.util.List getAvailableCommonMethodElementSignatures()
          Deprecated. used getAvailableUnspecifiedMethodElementSignatures
 java.util.List getAvailableHomeMethodElements()
          This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Home interface.
 java.util.List getAvailableLocalHomeMethodElements()
          This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Local Home interface.
 java.util.List getAvailableLocalMethodElements()
          This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Local interface.
 java.util.List getAvailableRemoteMethodElements()
          This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Remote interface.
 java.util.List getAvailableUnspecifiedMethodElements()
          This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces.
 java.util.List getAvailableUnspecifiedMethodElementSignatures()
          This method will return a List of MethodElements signatures that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces.
 JavaClass getEjbClass()
           
 java.lang.String getEjbClassName()
           
 EJBJar getEjbJar()
           
 EJBLocalRef getEquivalentEJBLocalRef(EJBLocalRef anEjbLocalRef)
          Method getEquivalentEJBLocalRef.
 EjbRef getEquivalentEjbRef(EjbRef anEjbRef)
          Return an EjbRef contained by this bean which is equivalent to @anEjbRef.
 java.util.List getExistingOrAvailableMethodElements(org.eclipse.emf.ecore.EObject refObject)
          Return a List of all available MethodElements for all types as well as the existing MethodElements from the refObject.
 java.util.List getExistingOrAvailableMethodElements(org.eclipse.emf.ecore.EObject refObject, java.util.Comparator comparator)
          Return a List of all available MethodElements for all types as well as the existing MethodElements from the refObject.
 JavaClass getHomeInterface()
           
 java.lang.String getHomeInterfaceName()
           
 Method[] getHomeMethodsForDeployment()
           
 EJBLocalRef getLinkedEJBLocalReference(EnterpriseBean anEJB)
          Return an EJBLocalRef that is physically linked to @anEJB.
 EjbRef getLinkedEJBReference(EnterpriseBean anEJB)
          Return an EjbRef that is physically linked to @anEJB.
 JavaClass getLocalHomeInterface()
           
 java.lang.String getLocalHomeInterfaceName()
           
 Method[] getLocalHomeMethodsForDeployment()
           
 JavaClass getLocalInterface()
           
 java.lang.String getLocalInterfaceName()
           
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 JavaClass getRemoteInterface()
           
 java.lang.String getRemoteInterfaceName()
           
 Method[] getRemoteMethodsForDeployment()
           
 SecurityIdentity getSecurityIdentity()
           
 org.eclipse.emf.common.util.EList getSecurityRoleRefs()
           
 int getVersionID()
          returns an integer representing the version of the bean in the EJBJar
 boolean hasJavaReference(JavaClass aJavaClass)
          Return true if @aJavaClass as equal to the home, remote, bean class, or key class.
 boolean hasLocalClient()
          Return true if this EJB has a local interface and a local home interface.
 boolean hasRemoteClient()
          Return true if this EJB has a remote interface and a home interface.
 boolean isBeanManagedEntity()
          Return true if this ejb has BeanManagedPersistance.
 boolean isContainerManagedEntity()
           
 boolean isEntity()
           
 boolean isMessageDriven()
           
 boolean isSession()
           
 boolean isVersion1_X()
          Deprecated. - Use getVersionID()
 boolean isVersion2_X()
          Deprecated. - Use getVersionID()
 void reSyncSecurityRoleRef(java.lang.String existingRoleName, java.lang.String newRoleName)
          Fix the role-link on any contained role refs
 void setEjbClass(JavaClass value)
           
 void setEjbClassName(java.lang.String ejbClassName)
           
 void setEjbJar(EJBJar value)
           
 void setHomeInterface(JavaClass value)
           
 void setHomeInterfaceName(java.lang.String homeInterfaceName)
           
 void setLocalHomeInterface(JavaClass value)
           
 void setLocalHomeInterfaceName(java.lang.String localHomeInterfaceName)
           
 void setLocalInterface(JavaClass value)
           
 void setLocalInterfaceName(java.lang.String localInterfaceName)
           
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setRemoteInterface(JavaClass value)
           
 void setRemoteInterfaceName(java.lang.String remoteInterfaceName)
           
 void setSecurityIdentity(SecurityIdentity value)
           
 
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

createMethodElements

java.util.List createMethodElements(java.util.List someMethods,
                                    JavaClass anInterface)
Creates a List of MethodElements that represent the Methods from @someMethods pointing to this EJB. It is assumed that all of the methods belong to @anInterface.


getAvailableCommonMethodElements

java.util.List getAvailableCommonMethodElements()
Deprecated. used getAvailableUnspecifiedMethodElements

This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getAvailableUnspecifiedMethodElements

java.util.List getAvailableUnspecifiedMethodElements()
This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getAvailableCommonMethodElementSignatures

java.util.List getAvailableCommonMethodElementSignatures()
Deprecated. used getAvailableUnspecifiedMethodElementSignatures

This method will return a List of MethodElements signatures that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces.


getAvailableUnspecifiedMethodElementSignatures

java.util.List getAvailableUnspecifiedMethodElementSignatures()
This method will return a List of MethodElements signatures that represent all the possible MethodElements that can be created and are common to both the Home and Remote interfaces.


getAvailableHomeMethodElements

java.util.List getAvailableHomeMethodElements()
This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Home interface. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getAvailableLocalHomeMethodElements

java.util.List getAvailableLocalHomeMethodElements()
This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Local Home interface. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getAvailableLocalMethodElements

java.util.List getAvailableLocalMethodElements()
This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Local interface. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getAvailableRemoteMethodElements

java.util.List getAvailableRemoteMethodElements()
This method will return a List of newly created MethodElements that represent all the possible MethodElements that can be created for the Remote interface. These MethodElements are not contained and will not be serialized and should not be added to the model. Their intention is solely for comparing with actual MethodElements contained in the model.


getExistingOrAvailableMethodElements

java.util.List getExistingOrAvailableMethodElements(org.eclipse.emf.ecore.EObject refObject,
                                                    java.util.Comparator comparator)
Return a List of all available MethodElements for all types as well as the existing MethodElements from the refObject. The parameter will be either a MethodTransaction or a MethodPermission. The List will be sorted based on the passed EjbMethodElementComparator


getExistingOrAvailableMethodElements

java.util.List getExistingOrAvailableMethodElements(org.eclipse.emf.ecore.EObject refObject)
Return a List of all available MethodElements for all types as well as the existing MethodElements from the refObject. The parameter will be either a MethodTransaction or a MethodPermission. The List will be sorted based on the EjbMethodElementComparator


getEjbClassName

java.lang.String getEjbClassName()

getEquivalentEjbRef

EjbRef getEquivalentEjbRef(EjbRef anEjbRef)
Return an EjbRef contained by this bean which is equivalent to @anEjbRef.


getEquivalentEJBLocalRef

EJBLocalRef getEquivalentEJBLocalRef(EJBLocalRef anEjbLocalRef)
Method getEquivalentEJBLocalRef.

Parameters:
anEjbLocalRef -
Returns:
EJBLocalRef

getHomeInterfaceName

java.lang.String getHomeInterfaceName()

getHomeMethodsForDeployment

Method[] getHomeMethodsForDeployment()

getLinkedEJBReference

EjbRef getLinkedEJBReference(EnterpriseBean anEJB)
Return an EjbRef that is physically linked to @anEJB.


getLinkedEJBLocalReference

EJBLocalRef getLinkedEJBLocalReference(EnterpriseBean anEJB)
Return an EJBLocalRef that is physically linked to @anEJB.


getLocalHomeInterfaceName

java.lang.String getLocalHomeInterfaceName()

getLocalHomeMethodsForDeployment

Method[] getLocalHomeMethodsForDeployment()

getLocalInterfaceName

java.lang.String getLocalInterfaceName()

getRemoteInterfaceName

java.lang.String getRemoteInterfaceName()

getRemoteMethodsForDeployment

Method[] getRemoteMethodsForDeployment()

hasJavaReference

boolean hasJavaReference(JavaClass aJavaClass)
Return true if @aJavaClass as equal to the home, remote, bean class, or key class.


isBeanManagedEntity

boolean isBeanManagedEntity()
Return true if this ejb has BeanManagedPersistance.


isContainerManagedEntity

boolean isContainerManagedEntity()

isEntity

boolean isEntity()

isMessageDriven

boolean isMessageDriven()

isSession

boolean isSession()

getVersionID

int getVersionID()
returns an integer representing the version of the bean in the EJBJar

See Also:
J2EEVersionConstants

isVersion1_X

boolean isVersion1_X()
Deprecated. - Use getVersionID()

See Also:
J2EEVersionConstants

isVersion2_X

boolean isVersion2_X()
Deprecated. - Use getVersionID()

See Also:
J2EEVersionConstants

hasLocalClient

boolean hasLocalClient()
Return true if this EJB has a local interface and a local home interface.


hasRemoteClient

boolean hasRemoteClient()
Return true if this EJB has a remote interface and a home interface.


reSyncSecurityRoleRef

void reSyncSecurityRoleRef(java.lang.String existingRoleName,
                           java.lang.String newRoleName)
Fix the role-link on any contained role refs


setEjbClassName

void setEjbClassName(java.lang.String ejbClassName)

setHomeInterfaceName

void setHomeInterfaceName(java.lang.String homeInterfaceName)

setLocalHomeInterfaceName

void setLocalHomeInterfaceName(java.lang.String localHomeInterfaceName)

setLocalInterfaceName

void setLocalInterfaceName(java.lang.String localInterfaceName)

setRemoteInterfaceName

void setRemoteInterfaceName(java.lang.String remoteInterfaceName)

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Specified by:
getName in interface org.eclipse.emf.ecore.ENamedElement
Returns:
the value of the 'Name' attribute.
See Also:
setName(String), EjbPackage.getEnterpriseBean_Name()

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Specified by:
setName in interface org.eclipse.emf.ecore.ENamedElement
Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getSecurityRoleRefs

org.eclipse.emf.common.util.EList getSecurityRoleRefs()
Returns:
The list of SecurityRoleRefs references

getEjbClass

JavaClass getEjbClass()
Returns:
The EjbClass reference

setEjbClass

void setEjbClass(JavaClass value)
Parameters:
l - The new value of the EjbClass reference

getHomeInterface

JavaClass getHomeInterface()
Returns:
The HomeInterface reference

setHomeInterface

void setHomeInterface(JavaClass value)
Parameters:
l - The new value of the HomeInterface reference

getRemoteInterface

JavaClass getRemoteInterface()
Returns:
The RemoteInterface reference

setRemoteInterface

void setRemoteInterface(JavaClass value)
Parameters:
l - The new value of the RemoteInterface reference

getEjbJar

EJBJar getEjbJar()
Returns:
The EjbJar reference

setEjbJar

void setEjbJar(EJBJar value)
Parameters:
l - The new value of the EjbJar reference

getSecurityIdentity

SecurityIdentity getSecurityIdentity()
Returns:
The SecurityIdentity reference The security-identity element specifies whether the caller's security identity is to be used for the execution of the methods of the enterprise bean or whether a specific run-as identity is to be used. It contains an optional description and a specification of the security identity to be used.

setSecurityIdentity

void setSecurityIdentity(SecurityIdentity value)
Parameters:
l - The new value of the SecurityIdentity reference

getLocalHomeInterface

JavaClass getLocalHomeInterface()
Returns:
The LocalHomeInterface reference

setLocalHomeInterface

void setLocalHomeInterface(JavaClass value)
Parameters:
l - The new value of the LocalHomeInterface reference

getLocalInterface

JavaClass getLocalInterface()
Returns:
The LocalInterface reference

setLocalInterface

void setLocalInterface(JavaClass value)
Parameters:
l - The new value of the LocalInterface reference