Package de.xima.fc.workflow.processor.model

Class WorkflowQualifiedSubmitButton

java.lang.Object

de.xima.fc.workflow.processor.model.WorkflowQualifiedSubmitButton

All Implemented Interfaces:

IWorkflowQualifiedSubmitButton, Serializable

public final class WorkflowQualifiedSubmitButton
extends Object
implements IWorkflowQualifiedSubmitButton

POJO implementation of a IWorkflowQualifiedSubmitButton.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkflowQualifiedSubmitButton(String identifier, ESubmitButtonAction action, String pageName, String elementName, String displayName, String tooltip, List<XItemConditionsDescriptor> andStateConditions, List<XItemConditionsDescriptor> andUserGroupConditions)	Creates a new POJO instance with the given data.

Method Summary

Modifier and Type	Method	Description
ESubmitButtonAction	getAction()
List<XItemConditionsDescriptor>	getAndStateConditions()
List<XItemConditionsDescriptor>	getAndUserGroupConditions()
String	getDisplayName()
String	getElementName()
String	getPageName()
String	getTechnicalName()
String	getTooltip()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowQualifiedSubmitButton

public WorkflowQualifiedSubmitButton(String identifier,
                                     ESubmitButtonAction action,
                                     String pageName,
                                     String elementName,
                                     String displayName,
                                     String tooltip,
                                     List<XItemConditionsDescriptor> andStateConditions,
                                     List<XItemConditionsDescriptor> andUserGroupConditions)

Creates a new POJO instance with the given data.

Parameters:

identifier - The value for IWorkflowQualifiedSubmitButton.getTechnicalName().

action - The value for IWorkflowQualifiedSubmitButton.getAction().

pageName - The value for IWorkflowQualifiedSubmitButton.getPageName().

elementName - The value for IWorkflowQualifiedSubmitButton.getElementName().

displayName - The value for IWorkflowQualifiedSubmitButton.getDisplayName().

tooltip - The value for IWorkflowQualifiedSubmitButton.getTooltip().

andStateConditions - Conditions regarding the states when this button is available.

andUserGroupConditions - Conditions regarding the user groups when this button is available.

Method Detail

getAction

public ESubmitButtonAction getAction()

Specified by:

getAction in interface IWorkflowQualifiedSubmitButton

Returns:

The action that is performed when the submit button is pressed.

getAndStateConditions

public List<XItemConditionsDescriptor> getAndStateConditions()

Specified by:

getAndStateConditions in interface IWorkflowQualifiedSubmitButton

Returns:

A list of conditions on workflow states. The button may be pressed only when all of the conditions are fulfilled.

getAndUserGroupConditions

public List<XItemConditionsDescriptor> getAndUserGroupConditions()

Specified by:

getAndUserGroupConditions in interface IWorkflowQualifiedSubmitButton

Returns:

A list of conditions on user groups. The button may be pressed only when all of the conditions are fulfilled.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface IWorkflowQualifiedSubmitButton

Returns:

The name on the button as it is displayed to the user.

getElementName

public String getElementName()

Specified by:

getElementName in interface IWorkflowQualifiedSubmitButton

Returns:

The name of the button group form element that contains the button.

getPageName

public String getPageName()

Specified by:

getPageName in interface IWorkflowQualifiedSubmitButton

Returns:

The name of the page that contains this button.

getTechnicalName

public String getTechnicalName()

Specified by:

getTechnicalName in interface IWorkflowQualifiedSubmitButton

Returns:

The internal, technical name of the button, used to identify the button.

getTooltip

public String getTooltip()

Specified by:

getTooltip in interface IWorkflowQualifiedSubmitButton

Returns:

The tooltip of the button that appears when the user hovers over the button.