com.endeca.itl.cas.api

Class ModuleInfo

java.lang.Object

com.endeca.itl.cas.api.ModuleInfo

public class ModuleInfo
extends Object

A ModuleInfo stores general information about a module, including:

• ModuleId: a unique identifier for the kind of module
• Module type: whether it's a source or manipulator
• Display name: for showing to a user
• Description: so a user might quickly understand what the module does
• Capabilities: a list of Strings that document some of the capabilities of the module being configured.

Constructor Summary

Constructors

Constructor and Description
ModuleInfo()
ModuleInfo(ModuleId pModuleId)
ModuleInfo(ModuleInfo other)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
List<ModuleCapability>	getCapabilities()
String	getDescription() Gets the value of the description property.
String	getDisplayName() Gets the value of the displayName property.
ModuleId	getModuleId() Gets the value of the moduleId property.
ModuleType	getModuleType() Gets the value of the moduleType property.
boolean	hasCapability(ModuleCapability capability)
int	hashCode()
void	setCapabilities(List<ModuleCapability> capabilities)
void	setDescription(String value) Sets the value of the description property.
void	setDisplayName(String value) Sets the value of the displayName property.
void	setModuleId(ModuleId value) Sets the value of the moduleId property.
void	setModuleType(ModuleType value) Sets the value of the moduleType property.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleInfo

public ModuleInfo()

ModuleInfo

public ModuleInfo(ModuleInfo other)

ModuleInfo

public ModuleInfo(ModuleId pModuleId)

Method Detail

getModuleId

public ModuleId getModuleId()

Gets the value of the moduleId property.

Returns:

possible object is ModuleId

setModuleId

public void setModuleId(ModuleId value)

Sets the value of the moduleId property.

Parameters:

value - allowed object is ModuleId

getModuleType

public ModuleType getModuleType()

Gets the value of the moduleType property.

Returns:

possible object is ModuleType

setModuleType

public void setModuleType(ModuleType value)

Sets the value of the moduleType property.

Parameters:

value - allowed object is ModuleType

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Returns:

possible object is String

setDisplayName

public void setDisplayName(String value)

Sets the value of the displayName property.

Parameters:

value - allowed object is String

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getCapabilities

public List<ModuleCapability> getCapabilities()

setCapabilities

public void setCapabilities(List<ModuleCapability> capabilities)

hasCapability

public boolean hasCapability(ModuleCapability capability)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object