org.ikasan.spec.module

Interface Module<FLOW>

public interface Module<FLOW>

Ikasan module contracts.

Author:

Ikasan Development Team

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a human readable description of this module
FLOW	getFlow(String name) Returns a Flow with this name.
List<FLOW>	getFlows() Returns a Map of this module's Flows
String	getName() Returns the name of the module
String	getVersion() Returns the runtime version of the module
void	setDescription(String description) Sets a human readable description of this module

Method Detail

getVersion

String getVersion()

Returns the runtime version of the module

Returns:

version of the module

getName

String getName()

Returns the name of the module

Returns:

name of the module

getFlows

List<FLOW> getFlows()

Returns a Map of this module's Flows

Returns:

a map of Flow using the Flow#getName() as key

getFlow

FLOW getFlow(String name)

Returns a Flow with this name. If no flow of this name exists then it returns null.

Returns:

a the Flow corresponding to the given name

getDescription

String getDescription()

Returns a human readable description of this module

Returns:

String description

setDescription

void setDescription(String description)

Sets a human readable description of this module

Parameters:

String - description