|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JiraWorkflow
Field Summary | |
---|---|
static Collection |
ACTION_TYPE_ALL
|
static String |
ACTION_TYPE_COMMON
|
static String |
ACTION_TYPE_GLOBAL
|
static String |
ACTION_TYPE_INITIAL
|
static String |
ACTION_TYPE_ORDINARY
|
static String |
DEFAULT_WORKFLOW_NAME
|
static String[] |
JIRA_META_ATTRIBUTE_ALLOWED_LIST
Allowed 'jira.*' prefixes for workflow properties. |
static String |
JIRA_META_ATTRIBUTE_EDIT_ALLOWED
|
static String |
JIRA_META_ATTRIBUTE_EXCLUDE_RESOLUTION
|
static String |
JIRA_META_ATTRIBUTE_I18N
|
static String |
JIRA_META_ATTRIBUTE_KEY_PREFIX
|
static String |
JIRA_META_ATTRIBUTE_PERMISSION
|
static String |
STEP_STATUS_KEY
|
static String |
WORKFLOW_DESCRIPTION_ATTRIBUTE
|
static String |
WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE
|
Method Summary | |
---|---|
Collection |
getActionsForScreen(FieldScreen fieldScreen)
|
Collection |
getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Get all the actions which have a particular step as their unconditional result. |
String |
getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
|
Collection |
getAllActions()
Get all the actions in this workflow, global, common and from steps. |
String |
getDescription()
|
com.opensymphony.workflow.loader.WorkflowDescriptor |
getDescriptor()
|
org.ofbiz.core.entity.GenericValue |
getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
|
List |
getLinkedStatuses()
Returns all statuses for this workflow |
Status |
getLinkedStatusObject(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
|
List |
getLinkedStatusObjects()
Returns all statuses for this workflow |
com.opensymphony.workflow.loader.StepDescriptor |
getLinkedStep(org.ofbiz.core.entity.GenericValue status)
Get the StepDescriptor linked to the given status for this workflow. |
String |
getName()
|
int |
getNextActionId()
Get the next available action id |
Collection |
getPostFunctionsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
Returns all post-functions of the transition, including the ones on all conditional results, unconditional results and 'global' (non-result) postfunctions. |
Collection |
getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)
Returns a collection of all step descriptors that reference the given common action |
boolean |
isActive()
Determine whether this workflow object is currently active. |
boolean |
isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
|
boolean |
isDefault()
Determines if the workflow is the default JIRA workflow |
boolean |
isEditable()
Determines if the workflow can be modifed within JIRA. |
boolean |
isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
|
boolean |
isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
|
boolean |
isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
|
boolean |
isSystemWorkflow()
Determines if the workflow is loaded from XML or the database |
boolean |
removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Remove a step from the workflow. |
void |
reset()
|
void |
store()
Persist this workflow object if possible. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final String JIRA_META_ATTRIBUTE_KEY_PREFIX
static final String JIRA_META_ATTRIBUTE_PERMISSION
static final String JIRA_META_ATTRIBUTE_EDIT_ALLOWED
static final String JIRA_META_ATTRIBUTE_EXCLUDE_RESOLUTION
static final String JIRA_META_ATTRIBUTE_I18N
static final String[] JIRA_META_ATTRIBUTE_ALLOWED_LIST
static final String STEP_STATUS_KEY
static final String WORKFLOW_DESCRIPTION_ATTRIBUTE
static final String WORKFLOW_VIEW_FIELDLAYOUT_KEY_ATTRIBUTE
static final String DEFAULT_WORKFLOW_NAME
static final String ACTION_TYPE_INITIAL
static final String ACTION_TYPE_GLOBAL
static final String ACTION_TYPE_COMMON
static final String ACTION_TYPE_ORDINARY
static final Collection ACTION_TYPE_ALL
Method Detail |
---|
String getName()
String getDescription()
com.opensymphony.workflow.loader.WorkflowDescriptor getDescriptor()
Collection getAllActions()
ActionDescriptor
s.Collection getActionsWithResult(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
boolean removeStep(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
This method will also remove all actions with this step ID as their unconditional result.
com.opensymphony.workflow.loader.StepDescriptor getLinkedStep(org.ofbiz.core.entity.GenericValue status)
List getLinkedStatuses()
List
of GenericValue
List getLinkedStatusObjects()
List
of Status
objectsvoid store() throws WorkflowException
WorkflowException
boolean isActive() throws WorkflowException
WorkflowException
boolean isSystemWorkflow() throws WorkflowException
WorkflowException
boolean isEditable() throws WorkflowException
WorkflowException
boolean isDefault()
int getNextActionId()
Collection getStepsForTransition(com.opensymphony.workflow.loader.ActionDescriptor action)
Collection getPostFunctionsForTransition(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isInitialAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isCommonAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isGlobalAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
boolean isOrdinaryAction(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
org.ofbiz.core.entity.GenericValue getLinkedStatus(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
Status getLinkedStatusObject(com.opensymphony.workflow.loader.StepDescriptor stepDescriptor)
String getActionType(com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
void reset()
Collection getActionsForScreen(FieldScreen fieldScreen)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |