com.suncode.pwfl.workflow.form.action

Class ActionDefinition

java.lang.Object

com.suncode.pwfl.component.ComponentDefinition

com.suncode.pwfl.workflow.component.WorkflowComponent

com.suncode.pwfl.workflow.form.action.ActionDefinition

@Api
public class ActionDefinition
extends WorkflowComponent

Form action definition.

Author:

Rafał Nowacki 30 lis 2015

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	fragmentSupported(ActionUIFragment fragment)
ActionDestination	getDestination(ActionTarget actionTarget) Returns action destination that matches declared action target.
List<ActionDestination>	getDestinations() Form areas affected by the action.
List<ActionDestination.Type>	getDestinationsTypes() Form areas affected by the action.
ActionUIFragment[]	getFragments()
int	hashCode()
void	setFragments(ActionUIFragment[] fragments)
boolean	targetSupported(ActionTarget actionTarget) Returns true if this action can be used on specified target.

Methods inherited from class com.suncode.pwfl.component.ComponentDefinition

getCategories, getContextVariables, getDescription, getDocumentationLink, getIcon, getId, getName, getParameter, getParameters, getSource, isDeprecated, setDeprecated, setSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionDefinition

public ActionDefinition(String id,
                        LocalizedString name)

ActionDefinition

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

Method Detail

getDestinations

public List<ActionDestination> getDestinations()

Form areas affected by the action. Possible types are available in ActionDestination.Type.

Returns:

Form areas

getDestinationsTypes

public List<ActionDestination.Type> getDestinationsTypes()

Form areas affected by the action. Possible types are available in ActionDestination.Type.

Returns:

Form areas

getDestination

public ActionDestination getDestination(ActionTarget actionTarget)

Returns action destination that matches declared action target.

Returns:

action destination

targetSupported

public boolean targetSupported(ActionTarget actionTarget)

Returns true if this action can be used on specified target.

Parameters:

actionTarget - action target

Returns:

true if target is supported on this action

getFragments

public ActionUIFragment[] getFragments()

setFragments

public void setFragments(ActionUIFragment[] fragments)

fragmentSupported

public boolean fragmentSupported(ActionUIFragment fragment)

equals

public boolean equals(Object obj)

Overrides:

equals in class ComponentDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ComponentDefinition