com.atlassian.jira.plugin.corereports.web.action

Class ConfigureReport

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.action.JiraActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.ProjectActionSupport

com.atlassian.jira.plugin.corereports.web.action.ConfigureReport

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

@Named
public class ConfigureReport
extends ProjectActionSupport

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigureReport.DatePickerParameter A simple key/value holder for passing configurable options into a date field (e.g.
class	ConfigureReport.FieldOption
class	ConfigureReport.ObjectConfigurationField
class	ConfigureReport.SelectableFieldOption

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.ProjectActionSupport

projectManager

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description

ConfigureReport(ProjectManager projectManager, PermissionManager permissionManager, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.webresource.api.assembler.PageBuilderService page, com.atlassian.soy.renderer.SoyTemplateRenderer soy, ApplicationProperties appProperties, com.atlassian.jira.projects.api.sidebar.ProjectSidebarRenderer projectSidebarRenderer, com.atlassian.jira.plugin.corereports.web.action.ReportProjectContextResolver reportResultProjectContextResolver)

Method Summary

Modifier and Type	Method and Description
String	doDefault()
String	doExcelView()
protected String	doExecute()
String	getAtlToken()
String	getEncoding()
String	getFilterName(String key)
String	getFilterProjectName(String key)
Collection<String>	getFlushedErrorMessages() Get error messages, then get rid of them.
String	getGeneratedReport()
String	getLoginAdviceMessage()
boolean	getLoginAdvisable()
ObjectConfiguration	getObjectConfiguration()
Collection<? extends ConfigureReport.ObjectConfigurationField>	getObjectConfigurationFields()
String	getParamValue(String key)
List<String>	getParamValues(String key)
String	getQueryString()
ReportModuleDescriptor	getReport()
String	getReportKey()
String	getReportRemarks()
String	getReportRemarksHeader()
String	getReportRemarksLearnMoreURL()
Project	getSelectedProject() Gets the last viewed project that the user visited and still has permission to see.
Long	getSelectedProjectId()
String	getSidebarHtml()
boolean	isShowSaveButton()
void	setReportKey(String reportKey)

Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport

getBrowsableProjects, setSelectedProject, setSelectedProject

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

ConfigureReport

@Inject
public ConfigureReport(ProjectManager projectManager,
                               PermissionManager permissionManager,
                               com.atlassian.plugin.PluginAccessor pluginAccessor,
                               com.atlassian.event.api.EventPublisher eventPublisher,
                               com.atlassian.webresource.api.assembler.PageBuilderService page,
                               com.atlassian.soy.renderer.SoyTemplateRenderer soy,
                               ApplicationProperties appProperties,
                               com.atlassian.jira.projects.api.sidebar.ProjectSidebarRenderer projectSidebarRenderer,
                               com.atlassian.jira.plugin.corereports.web.action.ReportProjectContextResolver reportResultProjectContextResolver)

Parameters:

projectManager -

permissionManager -

pluginAccessor -

eventPublisher -

Since:

5.2

Method Detail

getParamValue

public String getParamValue(String key)

getSidebarHtml

public String getSidebarHtml()

getReportRemarks

public String getReportRemarks()

getReportRemarksHeader

public String getReportRemarksHeader()

getReportRemarksLearnMoreURL

public String getReportRemarksLearnMoreURL()

getParamValues

public List<String> getParamValues(String key)

doDefault

public String doDefault()
                 throws Exception

Overrides:

doDefault in class webwork.action.ActionSupport

Throws:

Exception

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

getSelectedProject

public Project getSelectedProject()

Description copied from class: JiraWebActionSupport

Gets the last viewed project that the user visited and still has permission to see.

Overrides:

getSelectedProject in class JiraWebActionSupport

Returns:

the last project the user visited.

See Also:

UserProjectHistoryManager.getCurrentProject(int, ApplicationUser)

doExcelView

public String doExcelView()
                   throws Exception

Throws:

Exception

getQueryString

public String getQueryString()

getEncoding

public String getEncoding()

getGeneratedReport

public String getGeneratedReport()

getReportKey

public String getReportKey()

setReportKey

public void setReportKey(String reportKey)

getReport

public ReportModuleDescriptor getReport()

getFlushedErrorMessages

public Collection<String> getFlushedErrorMessages()

Description copied from interface: ErrorCollection

Get error messages, then get rid of them.

Specified by:

getFlushedErrorMessages in interface ErrorCollection

Overrides:

getFlushedErrorMessages in class JiraWebActionSupport

Returns:

The (now cleared) error messages.

getSelectedProjectId

public Long getSelectedProjectId()

Overrides:

getSelectedProjectId in class ProjectActionSupport

getAtlToken

public String getAtlToken()

getObjectConfiguration

public ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException

Throws:

ObjectConfigurationException

getObjectConfigurationFields

public Collection<? extends ConfigureReport.ObjectConfigurationField> getObjectConfigurationFields()
                                                                                            throws ObjectConfigurationException

Throws:

ObjectConfigurationException

getLoginAdvisable

public boolean getLoginAdvisable()

getLoginAdviceMessage

public String getLoginAdviceMessage()

isShowSaveButton

public boolean isShowSaveButton()
                         throws ObjectConfigurationException

Throws:

ObjectConfigurationException

getFilterProjectName

public String getFilterProjectName(String key)

getFilterName

public String getFilterName(String key)