com.suncode.pwfl.component

Class ComponentDefinition

java.lang.Object

com.suncode.pwfl.component.ComponentDefinition

Direct Known Subclasses:

DataChooserDefinition, DataSourceDefinition, ScheduledTaskDefinition, ValidatorDefinition, WorkflowComponent

@Api
public class ComponentDefinition
extends Object

Component definition.

Author:

Rafał Nowacki 12 kwi 2016

Constructor Summary

Constructors

Constructor and Description
ComponentDefinition(ComponentDefinition definition)
ComponentDefinition(String id, String documentationLink, LocalizedString name, LocalizedString description, Icon icon, List<Category> categories, List<ParameterDefinition<?>> parameters, List<ContextVariable<?>> contextVariables, LocalizedString deprecationDescription)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Category>	getCategories()
List<ContextVariable<?>>	getContextVariables()
String	getDeprecationDescription()
String	getDescription()
String	getDocumentationLink()
Icon	getIcon()
String	getId() Component id.
String	getName()
ParameterDefinition<?>	getParameter(String id)
List<ParameterDefinition<?>>	getParameters()
ComponentSource	getSource()
int	hashCode()
boolean	isDeprecated()
void	setDeprecated(boolean deprecated)
void	setSource(ComponentSource source)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentDefinition

public ComponentDefinition(ComponentDefinition definition)

ComponentDefinition

public ComponentDefinition(String id,
                           String documentationLink,
                           LocalizedString name,
                           LocalizedString description,
                           Icon icon,
                           List<Category> categories,
                           List<ParameterDefinition<?>> parameters,
                           List<ContextVariable<?>> contextVariables,
                           LocalizedString deprecationDescription)

Method Detail

getId

public String getId()

Component id. Must be unique within all defined components of specific type.

Returns:

Unique component id.

getDocumentationLink

public String getDocumentationLink()

Returns:

link to component documentation.

getName

public String getName()

Returns:

Component name.

getDescription

public String getDescription()

Returns:

Component description.

getDeprecationDescription

public String getDeprecationDescription()

Returns:

Component deprecated description.

getIcon

public Icon getIcon()

Returns:

Component icon.

getCategories

public List<Category> getCategories()

Returns:

Component categories.

getContextVariables

public List<ContextVariable<?>> getContextVariables()

Returns:

Component context variables

getParameters

public List<ParameterDefinition<?>> getParameters()

Returns:

Component parameters.

getParameter

public ParameterDefinition<?> getParameter(String id)
                                    throws UnknownParameterException

Throws:

UnknownParameterException

getSource

public ComponentSource getSource()

setSource

public void setSource(ComponentSource source)

isDeprecated

public boolean isDeprecated()

setDeprecated

public void setDeprecated(boolean deprecated)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object