java.lang.Object | |
↳ | com.atlassian.jira.workflow.WorkflowUtil |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JRA-4429 (prevent invalid characters)
| |||||||||||
Converts a com.opensymphony.workflow.loader.WorkflowDescriptor to XML.
| |||||||||||
Converts a string representation of a workflow XML into the com.opensymphony.workflow.loader.WorkflowDescriptor
object representation.
| |||||||||||
Given a map of transientVars from a Workflow Function, returns the user's key of the caller.
| |||||||||||
Given a map of transientVars from a Workflow Function, returns the
ApplicationUser object of the caller. | |||||||||||
Get the next usable ID value for a given list of descriptors.
| |||||||||||
Get the next usable ID value for a given list of descriptors and a start point.
| |||||||||||
Appends "(Draft)" to the end of the workflow name for an draft workflow.
| |||||||||||
Get the translated description of the workflow transition.
| |||||||||||
Get the translated display name of a workflow transition.
| |||||||||||
Check if given workflow name is valid that means it: Is not blank, contains only ASCII characters, does not
contain leading or trailing whitespaces If any of the above is not meet the first error is added to
errorCollection
If workflow name is valid then no error will be added to errorCollection | |||||||||||
See
isAcceptableName(String, String, com.atlassian.jira.util.ErrorCollection)
This method does not provide information about error type. | |||||||||||
Return true if the passed string is a reserved workflow property key.
| |||||||||||
Sets the view and screen for the given action.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
JRA-4429 (prevent invalid characters)
Converts a com.opensymphony.workflow.loader.WorkflowDescriptor to XML.
descriptor | The com.opensymphony.workflow.loader.WorkflowDescriptor to convert |
---|
Converts a string representation of a workflow XML into the com.opensymphony.workflow.loader.WorkflowDescriptor object representation.
workflowDescriptorXML | the XML representation of an OSWorkflow |
---|
FactoryException | thrown if the XML is malformed or can not be converted to the object representation. |
---|
Given a map of transientVars from a Workflow Function, returns the user's key of the caller. It is highly
discouraged to use this method directly when fetching user object. Please use getCallerUser(java.util.Map)
instead.
transientVars | the "transientVars" from the workflow FunctionProvider |
---|
Given a map of transientVars from a Workflow Function, returns the ApplicationUser
object of the caller.
transientVars | the "transientVars" from the workflow FunctionProvider |
---|
Get the next usable ID value for a given list of descriptors.
Get the next usable ID value for a given list of descriptors and a start point.
Appends "(Draft)" to the end of the workflow name for an draft workflow.
workflow | The workflow to create the display name for. |
---|
Get the translated description of the workflow transition.
descriptor | The action descriptor to get the description of |
---|
Get the translated display name of a workflow transition.
descriptor | The action descriptor to get the name of |
---|
Check if given workflow name is valid that means it: Is not blank, contains only ASCII characters, does not
contain leading or trailing whitespaces If any of the above is not meet the first error is added to errorCollection
If workflow name is valid then no error will be added to errorCollection
workflowName | name of the workflow to check |
---|---|
fieldName | field name that the error should be associated with in errorCollection |
errorCollection | error collection that collects errors |
NullPointerException | if fieldName or errorCollection is null |
---|
See isAcceptableName(String, String, com.atlassian.jira.util.ErrorCollection)
This method does not provide information about error type.
Return true if the passed string is a reserved workflow property key. Reserved keys are those that can't be changed by the user and can only be used internally by JIRA. The UI tries to hide these keys from the user.
key | the key to check. |
---|
true
if the passed key is reserved or false
otherwise.
Sets the view and screen for the given action.
actionDescriptor | Action who's screen to set. |
---|---|
screen | Screen to be set for the action. Null indicates no screen. |