org.eclipse.jst.server.core
Interface IJ2EEModule

All Known Subinterfaces:
IApplicationClientModule, IConnectorModule, IEJBModule, IWebModule

public interface IJ2EEModule

An abstract J2EE module that can be deployed to a server.

Since:
1.0

Method Summary
 java.lang.String getJ2EESpecificationVersion()
          Returns a version number in the form "x.y.z".
 IPath getLocation()
          Returns the location of the root of the module.
 boolean isBinary()
          Returns true if this is a binary (zipped) module, and false if it is expanded.
 

Method Detail

getJ2EESpecificationVersion

public java.lang.String getJ2EESpecificationVersion()
Returns a version number in the form "x.y.z".

Returns:
the J2EE specification version

getLocation

public IPath getLocation()
Returns the location of the root of the module. May return null if isUnitTest() returns false. This should be an absolute path that is not workbench relative.

Returns:
the absolute path to the root of this application

isBinary

public boolean isBinary()
Returns true if this is a binary (zipped) module, and false if it is expanded.

If true, members() should return only a single element - the binary (jar or zip file) that contains the contents of this module. (a single IModuleResource, e.g. myejb.jar) Also, getLocation() should return the full path up to and including the binary itself. (e.g. c:\temp\myejb.jar)

If false, members() should return the entire contents of the module, starting at the root. There should be no preceeding directory structure. (an array of IModuleResources, e.g. index.html, WEB-INF/web.xml, ...) In this case, getLocation() should return the path to the root folder containing these resources.

Returns:
boolean