|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowPropertyEditor
An editor that can be used to perform CRUD operations on the properties of a workflow.
Nested Class Summary | |
---|---|
static interface |
WorkflowPropertyEditor.Result
Contains the result of a successful operation. |
static interface |
WorkflowPropertyEditor.WorkflowPropertyEditorFactory
Factory for WorkflowPropertyEditor instances. |
Field Summary | |
---|---|
static String |
DEFAULT_NAME_KEY
|
static String |
DEFAULT_VALUE_KEY
|
Method Summary | |
---|---|
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 |
---|
static final String DEFAULT_NAME_KEY
static final String DEFAULT_VALUE_KEY
Method Detail |
---|
ServiceOutcome<WorkflowPropertyEditor.Result> addProperty(String name, String value)
WorkflowPropertyEditor.Result
to
work out the actual name and value saved as they may have been transformed during the save.
name
- the name of the property.value
- the value of the property.
ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.ServiceOutcome<WorkflowPropertyEditor.Result> updateProperty(String name, String value)
WorkflowPropertyEditor.Result
to
work out the actual name and value saved as they may have been transformed during the save.
name
- the name of the property.value
- the value of the property.
ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.ServiceOutcome<WorkflowPropertyEditor.Result> deleteProperty(String name)
name
- the name of the property.
ServiceOutcome
either contains errors
or the WorkflowPropertyEditor.Result
of the operation if successful.WorkflowPropertyEditor nameKey(String nameKey)
ErrorCollection
when reporting
errors on the property name. The default is
DEFAULT_NAME_KEY
.
nameKey
- the name of the key to use.
WorkflowPropertyEditor valueKey(String valueKey)
ErrorCollection
when reporting
errors on the property value. The default is
DEFAULT_VALUE_KEY
.
valueKey
- the name of the key to use.
String getNameKey()
ErrorCollection
when reporting
errors on the property key.
String getValueKey()
ErrorCollection
when reporting
errors on the property value.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |