com.sssw.wf.ui.api
Interface EbiComponentDefinition

All Known Subinterfaces:

EbiDestinationDefinition, EbiLinkDefinition, EbiProcessDefinition

public interface EbiComponentDefinition

The base interface representing a link or process node definition in a workflow process definition.

See Also:

EbiProcessNodeDefinition, EbiLinkDefinition

Method Summary

Map[]	getCopyScopes() Get a Map of all the Scoped Paths to copy on a link
String	getDescription() Get component description.
String	getId() Get component id.
String	getName() Get component name.
Map[]	getPostScopes() Get a Map of all the Scoped Paths to copy after each activity
Map[]	getPreScopes() Get a Map of all the Scoped Paths to copy before each activity
NodeList	getProperties() Get component's properties.
Element	getProperty(String propName) Get components property tag.
void	setCopyScopes(Map[] scopes) Set the Map of all the Scoped Paths to copy on a link
void	setDescription(String description) Set component description.
void	setName(String name) Set component name.
void	setPostScopes(Map[] scopes) Set the Map of all the Scoped Paths to copy after each activity
void	setPreScopes(Map[] scopes) Set the Map of all the Scoped Paths to copy before each activity
void	setProperty(String propName, Object propValue, String propType) Add a property to the component's property list.
void	setProperty(String propName, Object propValue, String propType, boolean immutable) Add a property to the component's property list.

Method Detail

getId

public String getId()

Get component id. This returns a 32 byte GUID that uniquely identifies the component. This id identifies the component at runtime.

Returns:

name - the component's name

setName

public void setName(String name)

Set component name. This name identifies the component and appears in process definition.

Parameters:

name - - the component's name

getName

public String getName()

Get component name.

Returns:

name - the component's name

setDescription

public void setDescription(String description)

Set component description. Used to briefly describe component.

Parameters:

description - - the component's description

getDescription

public String getDescription()

Get component description.

Returns:

description - the component's description

setProperty

public void setProperty(String propName,
                        Object propValue,
                        String propType,
                        boolean immutable)

Add a property to the component's property list.

Parameters:

propName - - the property name

propValue - - the property value

propType - - the property type

immutable - - indicated whether the property is read-only

setProperty

public void setProperty(String propName,
                        Object propValue,
                        String propType)

Add a property to the component's property list. The property defaults to read-write

Parameters:

propName - - the property name

propValue - - the property value

propType - - the property type

getProperty

public Element getProperty(String propName)

Get components property tag.

Parameters:

propName - - the name of the requested property

Returns:

(Element) property - the component property tag

getProperties

public NodeList getProperties()

Get component's properties.

Returns:

(NodeList) properties - the component's property tags

getCopyScopes

public Map[] getCopyScopes()

Get a Map of all the Scoped Paths to copy on a link

setCopyScopes

public void setCopyScopes(Map[] scopes)

Set the Map of all the Scoped Paths to copy on a link

Parameters:

scopes - - the Map array of scoped paths to set

getPreScopes

public Map[] getPreScopes()

Get a Map of all the Scoped Paths to copy before each activity

setPreScopes

public void setPreScopes(Map[] scopes)

Set the Map of all the Scoped Paths to copy before each activity

Parameters:

scopes - - the Map array of scoped paths to set

getPostScopes

public Map[] getPostScopes()

Get a Map of all the Scoped Paths to copy after each activity

setPostScopes

public void setPostScopes(Map[] scopes)

Set the Map of all the Scoped Paths to copy after each activity

Parameters:

scopes - - the Map array of scoped paths to set