EditWorkflowDispatcher

Class Overview

Dispatcher in the form of an action that redirects requests to the appropriate URL for editing a workflow. If the workflow is inactive, edit it directly. If the workflow is active, edit its draft. If a draft does not exist, create one before redirecting.

Summary

[Expand] Inherited Constants
From class com.atlassian.jira.web.action.JiraWebActionSupport String ISSUE_NOT_FOUND_RESULT String PERMISSION_VIOLATION_RESULT String RETURN_URL_PARAMETER
From interface webwork.action.Action String ERROR String INPUT String LOGIN String NONE String SUCCESS

[Expand] Inherited Fields
From class com.atlassian.jira.web.action.JiraWebActionSupport protected HttpServletRequest request This field is deprecated. since 6.0 - use getHttpRequest() instead. protected Collection savedFilters
From class com.atlassian.jira.action.JiraActionSupport protected final Logger log
From class webwork.action.ActionSupport protected String command protected Map errorMap protected Collection errorMessages protected Log log

[Expand] Inherited Methods
From class com.atlassian.jira.web.action.JiraWebActionSupport void addError(String field, String message, ErrorCollection.Reason reason) Add a field-specific error message. void addErrorCollection(ErrorCollection errors) Populate this ErrorCollection with general and field-specific errors. void addErrorMessage(String message, ErrorCollection.Reason reason) Add error message relating to system state (not field-specific), and a reason. final void addErrorMessageByKeyIfAbsent(String errorMsgKey) final void addErrorMessageIfAbsent(String errorMsg) void addMessageToResponse(String msg, String type, boolean closeable, String target) This will populate the the custom Atlassian header with the details of a pop-up message. void addReason(ErrorCollection.Reason reason) Add a reason why the function has not been performed. void addReasons(Set<ErrorCollection.Reason> reasons) Add reasons why the function has not been performed. String forceRedirect(String redirect) This method will force a server redirect, with no security checks. String getAdministratorContactLink() Get the link, with Internationalised text for contacting the administrators of JIRA. ApplicationProperties getApplicationProperties() AuthorizationSupport getAuthorizationSupport() String getConglomerateCookieValue(String cookieName, String key) Retrieve the value from a conglomerate Cookie from the request. ConstantsManager getConstantsManager() String getDateFormat() String getDateTimeFormat() DateTimeFormatter getDateTimeFormatter() Returns a DateTimeFormatter that can be used to format times and dates in the user's time zone using RELATIVE. String getDescTranslation(GenericValue issueConstantGV) This method is deprecated. Use ConstantsManager instead. Since v6.0. DateTimeFormatter getDmyDateFormatter() Returns a DateTimeFormatter that can be used to format dates in the user's time zone using DATE. String getEmptyResponse() Returns an empty response code (204) Collection<String> getErrorMessages() Map<String, String> getErrors() Field getField(String id) Collection<String> getFlushedErrorMessages() Get error messages, then get rid of them. GlobalPermissionManager getGlobalPermissionManager() final Hint getHint(String context) final HintManager getHintManager() HttpServletRequest getHttpRequest() HttpServletResponse getHttpResponse() HttpSession getHttpSession() JiraContactHelper getJiraContactHelper() JiraServiceContext getJiraServiceContext() Provides a service context with the current user which contains this action as its ErrorCollection. String getLanguage() ApplicationUser getLoggedInApplicationUser() @Deprecated User getLoggedInUser() This method is deprecated. since 6.1 use getLoggedInApplicationUser() instead. String getNameTranslation(GenericValue issueConstantGV) This method is deprecated. Use ConstantsManager instead. Since v6.0. @Deprecated OutlookDate getOutlookDate() This method is deprecated. Use getDateTimeFormatter() instead. Since v5.0. PermissionManager getPermissionManager() ProjectManager getProjectManager() final Hint getRandomHint() Set<ErrorCollection.Reason> getReasons() A set of well known reasons why the function has not been performed. String getRedirect(String defaultUrl, boolean allowUnsafeRedirect) Redirects to the value of getReturnUrl(), falling back to defaultUrl if the returnUrl is not set. String getRedirect(String defaultUrl) Redirects to the value of getReturnUrl(), falling back to defaultUrl if the returnUrl is not set. @Nonnull final RedirectSanitiser getRedirectSanitiser() Returns a RedirectSanitiser implementation. String getReturnUrl() String getReturnUrlForCancelLink() The cancel links should not included the selectedIssueId, otherwise when returning to the issue navigator an issue updated notification will be shown. List<String> getSearchSortDescriptions(SearchRequest searchRequest) Project getSelectedProject() Gets the last viewed project that the user visited and still has permission to see. Project getSelectedProjectObject() Gets the last viewed project that the user visited and still has permission to see. String getServerId() ServletContext getServletContext() String getTimeFormat() UriValidator getUriValidator() String getUserFullName(String username) UserManager getUserManager() UserProjectHistoryManager getUserProjectHistoryManager() VersionManager getVersionManager() String getWebworkStack() For debugging JSPs; prints the webwork stack. String getWebworkStack(String selected) For debugging JSPs; prints the webwork stack, highlighting the specified node. String getXsrfToken() final boolean hasErrorMessage(String errorMsg) final boolean hasErrorMessageByKey(String errorMsgKey) boolean hasIssuePermission(int permissionsId, Issue issue) Returns true if the logged in user has the given permission type on the given Issue. boolean hasPermission(int permissionsId) Returns true if the logged in user has the given permission type. boolean hasProjectPermission(int permissionsId, Project project) Returns true if the logged in user has the given permission type on the given Project. String htmlEncode(String encodeMe) Convenience instance method to call static utility from webwork EL. String insertContextPath(String url) Prepends the context path to the URL if it begins with a forward slash (this is commonly used for redirects within a JIRA instance). boolean isHasIssuePermission(int permissionsId, GenericValue issue) Returns true if the logged in user has the given permission type on the given Issue. boolean isHasIssuePermission(String permName, GenericValue issue) Returns true if the logged in user has the given permission type on the given Issue. boolean isHasPermission(int permissionsId) This method is deprecated. Use hasPermission(int) instead. Since v6.0. boolean isHasPermission(String permName) This method is deprecated. Use hasPermission(int) instead. Since v6.0. @Deprecated boolean isHasPermission(String permName, GenericValue entity) Returns true if remote user has permission over given entity, false otherwise. boolean isHasProjectPermission(String permName, GenericValue project) This method is deprecated. Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0. boolean isHasProjectPermission(int permissionsId, GenericValue project) This method is deprecated. Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0. boolean isInlineDialogMode() This returns true if the action has been invoked as an inline dialog. boolean isSystemAdministrator() @Deprecated boolean isUserExists(String username) This method is deprecated. Use isUserExistsByName(String) or isUserExistsByKey(String) instead, as appropriate. Since v6.0. boolean isUserExistsByKey(String userkey) boolean isUserExistsByName(String username) String returnComplete(String url) String returnComplete() final String returnCompleteWithInlineRedirect(String url) This will return success response with body containing url to redirect. String returnCompleteWithInlineRedirectAndMsg(String url, String msg, String type, boolean closeable, String target) This method is deprecated. since 5.1. Use returnCompleteWithInlineRedirectAndMsg(String, String, MessageType, boolean, String) instead. String returnCompleteWithInlineRedirectAndMsg(String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target) This will redirect like returnCompleteWithInlineRedirect(String), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. String returnMsgToUser(String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target) This will redirect like returnComplete(), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. @Deprecated String returnMsgToUser(String url, String msg, String type, boolean closeable, String target) This method is deprecated. since 5.1. Use returnMsgToUser(String, String, MessageType, boolean, String) instead. void setConglomerateCookieValue(String cookieName, String key, String value) Set the value key/value pair in a conglomerate Cookie. void setInline(boolean inline) This is the web parameter setter for invoking an action as an inline dialog void setReasons(Set<ErrorCollection.Reason> reasons) Set reasons why the function has not been performed. void setReturnUrl(String returnUrl) void setSelectedProjectId(Long id) String urlEncode(String encode) Encodes the given string into application/x-www-form-urlencoded format, using the JIRA encoding scheme to obtain the bytes for unsafe characters.
From class com.atlassian.jira.action.JiraActionSupport void addErrorMessages(ActionResult aResult) void addErrorMessages(Collection<String> errorMessages) void addErrors(Map<String, String> errors) void addIllegalArgumentException(String fieldName, IllegalArgumentException e) Override this method from ActionSupport. String execute() final String getActionName() ApplicationProperties getApplicationProperties() <T> T getComponentInstanceOfType(Class<T> clazz) This can be called to get a component from the ComponentAccessor. ResourceBundle getDefaultResourceBundle() Returns the default ResourceBundle within JIRA, which does not include translations provided by plugins. GenericDelegator getDelegator() This method is deprecated. Use getOfBizDelegator() instead. Since v5.0. I18nHelper getI18nHelper() Set<String> getKeysForPrefix(String prefix) Given a prefix for an i18n key, this method will return all keys that start with the prefix specified. Locale getLocale() @Deprecated abstract User getLoggedInUser() This method is deprecated. since 6.1 use getLoggedInApplicationUser() instead. OfBizDelegator getOfBizDelegator() User getRemoteUser() This method is deprecated. Use getLoggedInUser() instead. Since v4.3. To be deleted in v6.0 ResourceBundle getResourceBundle() Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins. String getResult() Get a definitive result. String getText(String key, String value1, String value2, String value3, String value4) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key) String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object parameters) Called to return the formatted text of the specified i18n key or the key itself if no message can be found. String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7, String value8, String value9) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2, String value3) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7, Object value8) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7) Called to return the formatted text of the specified i18n key String getText(String key, Object value1, Object value2, Object value3) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getUnescapedText(String key) Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found String getUntransformedRawText(String key) Same as getUnescapedText(String) but does not apply any TranslationTransforms. Preferences getUserPreferences() WatcherManager getWatcherManager() This method is deprecated. Get this injected into your action instead. Since v6.0. boolean hasAnyErrors() boolean isIndexing() boolean isKeyDefined(String key) For the given key, checks whether such a key is defined in the locale context represented by this helper instance. void removeKeyOrAddError(Map params, String key, String messageKey) Checks if descriptorParams contains key and removes it, otherwise adds the error message with the given message key.
From class webwork.action.ActionSupport void addError(String arg0, String arg1) void addErrorMessage(String arg0) void addIllegalArgumentException(String arg0, IllegalArgumentException arg1) String doDefault() String doExecute() void doValidation() String execute() String getActionName() String getCommandName() Collection getErrorMessages() Map getErrors() boolean getHasErrorMessages() boolean getHasErrors() Locale getLocale() String getPropertyEditorMessage(String arg0, PropertyEditorException arg1) String getText(String arg0) ResourceBundle getTexts() ResourceBundle getTexts(String arg0) TimeZone getTimezone() boolean invalidInput() String invokeCommand() boolean isCommand(String arg0) void setCommand(String arg0) void setErrorMessages(Collection arg0) void setErrors(Map arg0) void validate()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.atlassian.jira.util.ErrorCollection void addError(String field, String message, ErrorCollection.Reason reason) Add a field-specific error message. void addError(String field, String message) Add a field-specific error message. void addErrorCollection(ErrorCollection errors) Populate this ErrorCollection with general and field-specific errors. void addErrorMessage(String message) Add error message relating to system state (not field-specific). void addErrorMessage(String message, ErrorCollection.Reason reason) Add error message relating to system state (not field-specific), and a reason. void addErrorMessages(Collection<String> errorMessages) Append new error messages to those already collected. void addErrors(Map<String, String> errors) Append new field-specific errors to those already collected. void addReason(ErrorCollection.Reason reason) Add a reason why the function has not been performed. void addReasons(Set<ErrorCollection.Reason> reasons) Add reasons why the function has not been performed. Collection<String> getErrorMessages() Get all non field-specific error messages. Map<String, String> getErrors() Get all field-specific errors. Collection<String> getFlushedErrorMessages() Get error messages, then get rid of them. Set<ErrorCollection.Reason> getReasons() A set of well known reasons why the function has not been performed. boolean hasAnyErrors() Whether any errors (of any type - field-specific or otherwise) have been collected. void setErrorMessages(Collection<String> errorMessages) Populate this ErrorCollection with a new set of messages (existing errors are lost). void setReasons(Set<ErrorCollection.Reason> reasons) Set reasons why the function has not been performed.
From interface com.atlassian.jira.util.I18nHelper ResourceBundle getDefaultResourceBundle() Returns the default ResourceBundle within JIRA, which does not include translations provided by plugins. Set<String> getKeysForPrefix(String prefix) Given a prefix for an i18n key, this method will return all keys that start with the prefix specified. Locale getLocale() ResourceBundle getResourceBundle() Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins. String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2, String value3, String value4) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object parameters) Called to return the formatted text of the specified i18n key or the key itself if no message can be found. String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7, String value8, String value9) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2, String value3) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7, Object value8) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7) Called to return the formatted text of the specified i18n key String getText(String key, Object value1, Object value2, Object value3) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getText(String key, String value1, String value2) Called to return the formatted text of the specified i18n key or the key itself if no message can be found String getUnescapedText(String key) Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found String getUntransformedRawText(String key) Same as getUnescapedText(String) but does not apply any TranslationTransforms. boolean isKeyDefined(String key) For the given key, checks whether such a key is defined in the locale context represented by this helper instance.
From interface com.atlassian.jira.web.HttpServletVariables HttpServletRequest getHttpRequest() HttpServletResponse getHttpResponse() HttpSession getHttpSession() ServletContext getServletContext()
From interface com.atlassian.jira.web.util.AuthorizationSupport boolean hasIssuePermission(int permissionsId, Issue issue) Returns true if the logged in user has the given permission type on the given Issue. boolean hasPermission(int permissionsId) Returns true if the logged in user has the given permission type. boolean hasProjectPermission(int permissionsId, Project project) Returns true if the logged in user has the given permission type on the given Project. boolean isHasIssuePermission(int permissionsId, GenericValue issue) This method is deprecated. Use hasIssuePermission(int, com.atlassian.jira.issue.Issue) instead. Since v6.0. boolean isHasIssuePermission(String permName, GenericValue issue) This method is deprecated. Use hasIssuePermission(int, com.atlassian.jira.issue.Issue) instead. Since v6.0. boolean isHasPermission(String permName) This method is deprecated. Use hasPermission(int) instead. Since v6.0. @Deprecated boolean isHasPermission(String permName, GenericValue entity) This method is deprecated. since 4.3. Please use either isHasIssuePermission(String, org.ofbiz.core.entity.GenericValue), isHasIssuePermission(int, org.ofbiz.core.entity.GenericValue) or isHasProjectPermission(String, org.ofbiz.core.entity.GenericValue), isHasProjectPermission(int, org.ofbiz.core.entity.GenericValue). boolean isHasPermission(int permissionsId) This method is deprecated. Use hasPermission(int) instead. Since v6.0. boolean isHasProjectPermission(int permissionsId, GenericValue project) This method is deprecated. Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0. boolean isHasProjectPermission(String permName, GenericValue project) This method is deprecated. Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0.
From interface webwork.action.Action String execute()
From interface webwork.action.CommandDriven String getCommandName() void setCommand(String arg0)
From interface webwork.action.IllegalArgumentAware void addIllegalArgumentException(String arg0, IllegalArgumentException arg1)