org.eclipse.jst.j2ee.application
Interface Application

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface Application
extends CompatibilityDescriptionGroup

The application element is the root element of a J2EE application deployment descriptor.

Since:
1.0

Method Summary
 boolean containsSecurityRole(java.lang.String name)
           
 Module getFirstModule(java.lang.String uri)
          Returns the first module matching the specified uri
 int getJ2EEVersionID()
          This returns the j2ee version id.
 Module getModule(java.lang.String uri)
          Deprecated. preferably use getModule(String, String) or getFirstModule(String) There may be multiple modules with the same uri but different alt-dds
 Module getModule(java.lang.String uri, java.lang.String altDD)
          Returns the first module matching the specified uri and altDD
 Module getModuleHavingAltDD(java.lang.String uri)
          Returns the first module where the alt dd matches the specified uri
 org.eclipse.emf.common.util.EList getModules()
           
 SecurityRole getSecurityRoleNamed(java.lang.String name)
           
 org.eclipse.emf.common.util.EList getSecurityRoles()
           
 java.lang.String getVersion()
          Returns the value of the 'Version' attribute
 int getVersionID()
          This returns the module version id.
 boolean isVersion1_2Descriptor()
          Deprecated. Use getVersionID() to determine module level
 boolean isVersion1_3Descriptor()
          Deprecated. Use getVersionID() to determine module level
 void setVersion(java.lang.String value)
          Sets the value of the 'Version' attribute
 
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
 

Method Detail

containsSecurityRole

boolean containsSecurityRole(java.lang.String name)
Parameters:
name - - String role name
Returns:
if contains the role

getModule

Module getModule(java.lang.String uri,
                 java.lang.String altDD)
Returns the first module matching the specified uri and altDD

Parameters:
uri - - String aURI
altDD - - String altDD
Returns:
the first module matching the specified uri and altDD

getModule

Module getModule(java.lang.String uri)
Deprecated. preferably use getModule(String, String) or getFirstModule(String) There may be multiple modules with the same uri but different alt-dds

Returns the first module matching the specified uri

Parameters:
uri - - String uri
Returns:
the first module matching the specified uri

getJ2EEVersionID

int getJ2EEVersionID()
                     throws java.lang.IllegalStateException
This returns the j2ee version id. Compare with J2EEVersionConstants to determine j2ee level

Returns:
returns the j2ee version id
Throws:
java.lang.IllegalStateException - - When resource is proxy

getVersionID

int getVersionID()
                 throws java.lang.IllegalStateException
This returns the module version id. Compare with J2EEVersionConstants to determine module level

Returns:
returns the module version id
Throws:
java.lang.IllegalStateException - - When resource is proxy

getFirstModule

Module getFirstModule(java.lang.String uri)
Returns the first module matching the specified uri

Parameters:
uri - - String uri path
Returns:
the first module matching the specified uri

getModuleHavingAltDD

Module getModuleHavingAltDD(java.lang.String uri)
Returns the first module where the alt dd matches the specified uri

Parameters:
uri - - String uri path
Returns:
the first module where the alt dd matches the specified uri

getSecurityRoleNamed

SecurityRole getSecurityRoleNamed(java.lang.String name)
Parameters:
name - - String role name
Returns:
security role with name

isVersion1_2Descriptor

boolean isVersion1_2Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Application was populated from an Applcation1.2 compliant descriptor

Returns:
boolean

isVersion1_3Descriptor

boolean isVersion1_3Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Application was populated from an Application1.3 compliant descriptor

Returns:
boolean

getVersion

java.lang.String getVersion()
Returns the value of the 'Version' attribute.

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

Returns:
the value of the 'Version' attribute.
See Also:
setVersion(String), ApplicationPackage.getApplication_Version()

setVersion

void setVersion(java.lang.String value)
Sets the value of the 'Version' attribute.

Parameters:
value - the new value of the 'Version' attribute.
See Also:
getVersion()

getSecurityRoles

org.eclipse.emf.common.util.EList getSecurityRoles()
Returns:
The list of SecurityRoles references Contains the definitions of security roles which are global to the application.

getModules

org.eclipse.emf.common.util.EList getModules()
Returns:
The list of Modules references