public final class DefaultWorkflowPropertyEditor extends Object implements WorkflowPropertyEditor
Modifier and Type | Class and Description |
---|---|
static class |
DefaultWorkflowPropertyEditor.DefaultWorkflowPropertyEditorFactory |
WorkflowPropertyEditor.Result, WorkflowPropertyEditor.WorkflowPropertyEditorFactory
DEFAULT_NAME_KEY, DEFAULT_VALUE_KEY
Modifier and Type | Method and Description |
---|---|
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. |
public ServiceOutcome<WorkflowPropertyEditor.Result> addProperty(String name, String property)
WorkflowPropertyEditor
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.
addProperty
in interface WorkflowPropertyEditor
name
- the name of the property.property
- the value of the property.ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.public ServiceOutcome<WorkflowPropertyEditor.Result> updateProperty(String name, String property)
WorkflowPropertyEditor
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.
updateProperty
in interface WorkflowPropertyEditor
name
- the name of the property.property
- the value of the property.ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.public ServiceOutcome<WorkflowPropertyEditor.Result> deleteProperty(String name)
WorkflowPropertyEditor
deleteProperty
in interface WorkflowPropertyEditor
name
- the name of the property.ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.public WorkflowPropertyEditor nameKey(String nameKey)
WorkflowPropertyEditor
ErrorCollection
when reporting
errors on the property name. The default is
WorkflowPropertyEditor.DEFAULT_NAME_KEY
.nameKey
in interface WorkflowPropertyEditor
nameKey
- the name of the key to use.public WorkflowPropertyEditor valueKey(String valueKey)
WorkflowPropertyEditor
ErrorCollection
when reporting
errors on the property value. The default is
WorkflowPropertyEditor.DEFAULT_VALUE_KEY
.valueKey
in interface WorkflowPropertyEditor
valueKey
- the name of the key to use.public String getNameKey()
WorkflowPropertyEditor
ErrorCollection
when reporting
errors on the property key.getNameKey
in interface WorkflowPropertyEditor
public String getValueKey()
WorkflowPropertyEditor
ErrorCollection
when reporting
errors on the property value.getValueKey
in interface WorkflowPropertyEditor
Copyright © 2002-2019 Atlassian. All Rights Reserved.