de.espirit.firstspirit.module.descriptor

Interface ComponentDescriptor

All Superinterfaces:

Descriptor, Serializable

All Known Implementing Classes:

EditorDescriptor, LibraryDescriptor, ProjectAppDescriptor, PublicClassDescriptor, ServiceDescriptor, WebAppDescriptor, WebServerDescriptor

public interface ComponentDescriptor
extends Descriptor

The component descriptor contains name, type, class and other information of a Component.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComponentDescriptor.Scope The scope describes the place where the component is available: server-wide, project-local or web-local.
static class	ComponentDescriptor.Type Deprecated. since 4.2.200. no replacement - Components must implement proper interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentClass() Returns component class-name.
String	getConfiguration() Returns configuration string.
String	getConfigurationClass() Returns configuration class-name.
String	getDescription() Returns an english component description.
String	getDisplayName() Returns the component displayname.
String	getModuleName() Returns module name.
String	getName() Returns the component name which has to be unique inside a single module.
de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor[]	getResources() Returns resources (jar-files) neccessary for this component.
ComponentDescriptor.Scope	getScope() Returns component scope.
ComponentDescriptor.Type	getType() Returns component type.
String	getVersion() Returns component version (multiple numbers separated only by dots, e.g.
boolean	isHidden() Returns true if component is hidden in adminconsole, and false (by default) otherwise
boolean	isUnknown() Returns true if this component descriptor is unknown, occures when an imported project has a module installed, which is unknown on the firstspirit server.

Method Detail

isUnknown

boolean isUnknown()

Returns true if this component descriptor is unknown, occures when an imported project has a module installed, which is unknown on the firstspirit server. Returns false otherwise (default)

Returns:

boolean which describes the unknown state of this component

Since:

4.1

isHidden

boolean isHidden()

Returns true if component is hidden in adminconsole, and false (by default) otherwise

Returns:

true if component is hidden in adminconsole, and false (by default) otherwise

Since:

4.1

getConfiguration

@Nullable
String getConfiguration()

Returns configuration string.

Specified by:

getConfiguration in interface Descriptor

Since:

4.2.400

getDescription

String getDescription()

Returns an english component description.

Specified by:

getDescription in interface Descriptor

Returns:

component description.

Since:

4.1

getName

String getName()

Returns the component name which has to be unique inside a single module.

Specified by:

getName in interface Descriptor

Returns:

component name.

Since:

4.1

getDisplayName

String getDisplayName()

Returns the component displayname.

Specified by:

getDisplayName in interface Descriptor

Returns:

component displayname.

Since:

5.0.203

getModuleName

String getModuleName()

Returns module name.

Returns:

module name.

Since:

4.1

getVersion

String getVersion()

Returns component version (multiple numbers separated only by dots, e.g. "1.2.3.4").

Specified by:

getVersion in interface Descriptor

Returns:

component version.

Since:

4.1

getComponentClass

@Nullable
String getComponentClass()

Returns component class-name.

Returns:

component class-name.

Since:

4.1

getConfigurationClass

String getConfigurationClass()

Returns configuration class-name.

Returns:

configuration class-name.

Since:

4.1

getScope

ComponentDescriptor.Scope getScope()

Returns component scope.

Returns:

component scope.

Since:

4.1

getType

ComponentDescriptor.Type getType()

Returns component type.

Returns:

component type.

Since:

4.1

getResources

de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor[] getResources()

Returns resources (jar-files) neccessary for this component.

Returns:

neccessary resources (jar-files).

Since:

4.1