com.atlassian.jira.workflow

Interface WorkflowPropertyEditor

All Known Implementing Classes:

DefaultWorkflowPropertyEditor

public interface WorkflowPropertyEditor

An editor that can be used to perform CRUD operations on the properties of a workflow.

Since:

v6.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WorkflowPropertyEditor.Result Contains the result of a successful operation.
static interface	WorkflowPropertyEditor.WorkflowPropertyEditorFactory Factory for WorkflowPropertyEditor instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME_KEY
static String	DEFAULT_VALUE_KEY

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<WorkflowPropertyEditor.Result>	addProperty(String name, String value) Add a property to the workflow.
ServiceOutcome<WorkflowPropertyEditor.Result>	deleteProperty(String name) Delete a property from the workflow.
String	getNameKey() Return the key used by the editor in the ErrorCollection when reporting errors on the property key.
String	getValueKey() Return the key used by the editor in the ErrorCollection when reporting errors on the property value.
WorkflowPropertyEditor	nameKey(String nameKey) Set the key used by the editor in the ErrorCollection when reporting errors on the property name.
ServiceOutcome<WorkflowPropertyEditor.Result>	updateProperty(String name, String value) Update a property on the workflow.
WorkflowPropertyEditor	valueKey(String valueKey) Set the key used by the editor in the ErrorCollection when reporting errors on the property value.

Field Detail

DEFAULT_NAME_KEY

static final String DEFAULT_NAME_KEY

See Also:

Constant Field Values

DEFAULT_VALUE_KEY

static final String DEFAULT_VALUE_KEY

See Also:

Constant Field Values

Method Detail

addProperty

ServiceOutcome<WorkflowPropertyEditor.Result> addProperty(String name,
                                                          String value)

Add a property to the workflow. It is an error to try an update a property that already exists.

The caller must check the returned WorkflowPropertyEditor.Result to work out the actual name and value saved as they may have been transformed during the save.

Parameters:

name - the name of the property.

value - the value of the property.

Returns:

the result of the operation. The ServiceOutcome either contains errors or the WorkflowPropertyEditor.Result of the operation if successful.

updateProperty

ServiceOutcome<WorkflowPropertyEditor.Result> updateProperty(String name,
                                                             String value)

Update a property on the workflow. A property that does not exist will be added if necessary.

The caller must check the returned WorkflowPropertyEditor.Result to work out the actual name and value saved as they may have been transformed during the save.

Parameters:

name - the name of the property.

value - the value of the property.

Returns:

the result of the operation. The ServiceOutcome either contains errors or the WorkflowPropertyEditor.Result of the operation if successful.

deleteProperty

ServiceOutcome<WorkflowPropertyEditor.Result> deleteProperty(String name)

Delete a property from the workflow.

Parameters:

name - the name of the property.

Returns:

the result of the operation. The ServiceOutcome either contains errors or the WorkflowPropertyEditor.Result of the operation if successful.

nameKey

WorkflowPropertyEditor nameKey(String nameKey)

Set the key used by the editor in the ErrorCollection when reporting errors on the property name. The default is DEFAULT_NAME_KEY.

Parameters:

nameKey - the name of the key to use.

Returns:

the current editor.

valueKey

WorkflowPropertyEditor valueKey(String valueKey)

Set the key used by the editor in the ErrorCollection when reporting errors on the property value. The default is DEFAULT_VALUE_KEY.

Parameters:

valueKey - the name of the key to use.

Returns:

the current editor.

getNameKey

String getNameKey()

Return the key used by the editor in the ErrorCollection when reporting errors on the property key.

Returns:

the key used by the editor to report property name errors.

getValueKey

String getValueKey()

Return the key used by the editor in the ErrorCollection when reporting errors on the property value.

Returns:

the key used by the editor to report property key errors.