org.eclipse.jst.j2ee.application
Interface Module

All Superinterfaces:
J2EEEObject
All Known Subinterfaces:
ConnectorModule, EjbModule, JavaClientModule, WebModule

public interface Module
extends J2EEEObject

The module element represents a single J2EE module and contains an ejb, java, or web element, which indicates the module type and contains a path to the module file, and an optional alt-dd element, which specifies an optional URI to the post-assembly version of the deployment descriptor. The application deployment descriptor must have one module element for each J2EE module in the application package.

Since:
1.0

Method Summary
 java.lang.String getAltDD()
           
 Application getApplication()
           
 java.lang.String getUri()
           
 boolean isConnectorModule()
          Returns boolean value if this Module represents a ConnectorModule
 boolean isEjbModule()
          Returns boolean value if this Module represents a EjbModule
 boolean isJavaModule()
          Returns boolean value if this Module represents a JavaClientModule(ApplicationClient)
 boolean isWebModule()
          Returns boolean value if this Module represents a WebModule
 void setAltDD(java.lang.String value)
           
 void setApplication(Application value)
           
 void setUri(java.lang.String value)
           
 

Method Detail

isConnectorModule

public boolean isConnectorModule()
Returns boolean value if this Module represents a ConnectorModule

Returns:
boolean value

isEjbModule

public boolean isEjbModule()
Returns boolean value if this Module represents a EjbModule

Returns:
boolean value

isJavaModule

public boolean isJavaModule()
Returns boolean value if this Module represents a JavaClientModule(ApplicationClient)

Returns:
boolean value

isWebModule

public boolean isWebModule()
Returns boolean value if this Module represents a WebModule

Returns:
boolean value

getUri

public java.lang.String getUri()
Returns:
The value of the Uri attribute Specifies the URI of a module, relative to the top level of the application package.

setUri

public void setUri(java.lang.String value)
Parameters:
value - The new value of the Uri attribute

getAltDD

public java.lang.String getAltDD()
Returns:
The value of the AltDD attribute The alt-dd element specifies an optional URI to the post-assembly version of the deployment descriptor file for a particular J2EE module. The URI must specify the full pathname of the deployment descriptor file relative to the application's root directory. If alt-dd is not specified, the deployer must read the deployment descriptor from the default location and file name required by the respective component specification.

setAltDD

public void setAltDD(java.lang.String value)
Parameters:
value - The new value of the AltDD attribute

getApplication

public Application getApplication()
Returns:
The Application reference

setApplication

public void setApplication(Application value)
Parameters:
value - The new value of the Application reference