org.eclipse.wst.server.core
Interface IModuleType

public interface IModuleType

Represents the type of a module.

This interface is not intended to be implemented by clients.

Caveat: The server core API is still in an early form, and is likely to change significantly before the initial release.

Since:

1.0

Method Summary

java.lang.String	getId() Returns the module type id.
java.lang.String	getName() Returns the displayable name for this module type.
java.lang.String	getVersion() Returns the version (specification level) of this module type, e.g.

Method Detail

getId

public java.lang.String getId()

Returns the module type id.

The module type id is a "." separated string uniquely identifying the type of module. Like a java package name, it should scope the type from most general to specific. For instance, "j2ee.web".

Returns:

the module type id

getName

public java.lang.String getName()

Returns the displayable name for this module type.

Note that this name is appropriate for the current locale.

Returns:

a displayable name for this module type

getVersion

public java.lang.String getVersion()

Returns the version (specification level) of this module type, e.g. "1.0" or "1.3.2a".

The version will normally be a series of numbers separated by ".", but it could be different depending on the type of module. For module types where a version does not make sense (e.g. a static Web module), null is returned.

Returns:

the specification version of this module type, or null if there is no version