public final class

DefaultWorkflowPropertyEditor

extends Object
implements WorkflowPropertyEditor
java.lang.Object
   ↳ com.atlassian.jira.workflow.DefaultWorkflowPropertyEditor

Summary

Nested Classes
class DefaultWorkflowPropertyEditor.DefaultWorkflowPropertyEditorFactory  
[Expand]
Inherited Constants
From interface com.atlassian.jira.workflow.WorkflowPropertyEditor
Public Methods
ServiceOutcome<WorkflowPropertyEditor.Result> addProperty(String name, String property)
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 property)
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.workflow.WorkflowPropertyEditor

Public Methods

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

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.
property the value of the property.
Returns

public ServiceOutcome<WorkflowPropertyEditor.Result> deleteProperty (String name)

Delete a property from the workflow.

Parameters
name the name of the property.
Returns

public 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.

public 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.

public 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.

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

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.
property the value of the property.
Returns

public 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.