com.atlassian.jira.web.action
Class AbstractViewIssueColumns

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.web.action.IssueActionSupport
                      com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
                          com.atlassian.jira.web.action.AbstractViewIssueColumns

All Implemented Interfaces:

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

Direct Known Subclasses:

ViewIssueColumns, ViewSearchRequestIssueColumns, ViewUserIssueColumns

public abstract class AbstractViewIssueColumns
extends SearchDescriptionEnabledAction
implements FilterOperationsAction

See Also:

Serialized Form

Nested Class Summary

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

static int	ADD
static int	DELETE
static int	HIDE_ACTIONS
static int	MOVELEFT
static int	MOVERIGHT
static int	RESTORE
static int	SHOW_ACTIONS

Fields inherited from class com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction

fieldValuesHolder, issueSearcherManager

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

attachmentManager

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

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

AbstractViewIssueColumns(IssueSearcherManager issueSearcherManager, SearchService searchService, SearchSortUtil searchSortUtil)

Method Summary

abstract String	doHideActionsColumn() Removes the Actions and Operations drop down column from the issue table
protected abstract String	doRestoreDefault()
abstract String	doShowActionsColumn() Adds the Actions and Operations drop down column to the issue table
abstract String	getActionLocation(String prefix)
List	getAddableColumns()
protected abstract List<NavigableField>	getAvailableNavigatableFields()
protected abstract EditableColumnLayout	getColumnLayout() This function retrieve an editable column layout and assumes that the same object is returned during the lifetime of this object
protected ColumnLayoutManager	getColumnLayoutManager()
List	getColumns()
String	getFieldId()
protected FieldManager	getFieldManager()
Integer	getFieldPosition()
PagerFilter	getPager()
List<Issue>	getSampleIssues()
boolean	isFieldHidden(Long projectId, String id, String issueTypeId) Checks if the field is hidden in the project with id of projectId and the issueType of issue with id of issueId.
protected String	redirectToView()
protected String	runOperation()
void	setFieldId(String fieldId)
void	setFieldPosition(Integer fieldPosition)
void	setOperation(int operation)
protected abstract void	store()

Methods inherited from class com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction

createFilterOperationsBean, getActionParams, getFieldValuesHolder, getFilterOperationsBean, getSearchContext, getSearcherGroups, getSearchers, getSearcherViewHtml, getSearchRequestJqlString, getSearchSorts, isFilterFavourite, isFilterValid, isSearchRequestFitsNavigator, isShown, populateFieldValuesHolderFromQuery, validateSearchFilterIsSavedFilter

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

clearSelectedIssue, getAttachmentManager, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getHoursPerDay, getIssueManager, getLastFailedLogin, getLastLogin, getLoginCount, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getPreviousLogin, getSearchRequest, getSelectedIssueId, getSessionPagerFilterManager, getSessionSearchRequestManager, getSessionSearchRequestManagerFactory, getSessionSelectedIssueManager, getTotalFailedLoginCount, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isElevatedSecurityCheckRequired, isFieldHidden, isFieldHidden, isTimeTrackingEnabled, setCurrentIssue, setSearchRequest, setSelectedIssueId, updateSearchRequest

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

getBrowseableProjects, getBrowseableProjectsInCategory, getSelectedProjectId, setSelectedProject, setSelectedProject

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

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAssignableUsers, getAssignableUsers, getComponentManager, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRandomHint, getReasons, getRedirect, getRedirectChecker, getRemoteUser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getTimeFormat, getUriValidator, getUserFullName, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId

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

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doExecute, doValidation, getCommandName, getErrorMessages, getErrors, 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.web.action.filter.FilterOperationsAction

getFilterOperationsBean, isFilterValid

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

addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Field Detail

ADD

public static final int ADD

See Also:

Constant Field Values

DELETE

public static final int DELETE

See Also:

Constant Field Values

MOVELEFT

public static final int MOVELEFT

See Also:

Constant Field Values

MOVERIGHT

public static final int MOVERIGHT

See Also:

Constant Field Values

RESTORE

public static final int RESTORE

See Also:

Constant Field Values

SHOW_ACTIONS

public static final int SHOW_ACTIONS

See Also:

Constant Field Values

HIDE_ACTIONS

public static final int HIDE_ACTIONS

See Also:

Constant Field Values

Constructor Detail

AbstractViewIssueColumns

public AbstractViewIssueColumns(IssueSearcherManager issueSearcherManager,
                                SearchService searchService,
                                SearchSortUtil searchSortUtil)

Method Detail

runOperation

protected String runOperation()
                       throws Exception

Throws:

Exception

redirectToView

protected String redirectToView()

doShowActionsColumn

public abstract String doShowActionsColumn()
                                    throws Exception

Adds the Actions and Operations drop down column to the issue table

Returns:

Should always return INPUT to redirect back the edit columns page.

Throws:

Exception - if something bad happens...

Since:

v4.0

doHideActionsColumn

public abstract String doHideActionsColumn()
                                    throws Exception

Removes the Actions and Operations drop down column from the issue table

Returns:

Should always return INPUT to redirect back the edit columns page.

Throws:

Exception - if something bad happens...

Since:

v4.0

doRestoreDefault

protected abstract String doRestoreDefault()

store

protected abstract void store()

getFieldManager

protected FieldManager getFieldManager()

setOperation

public void setOperation(int operation)

getFieldId

public String getFieldId()

setFieldId

public void setFieldId(String fieldId)

getFieldPosition

public Integer getFieldPosition()

setFieldPosition

public void setFieldPosition(Integer fieldPosition)

getColumns

public List getColumns()

getActionLocation

public abstract String getActionLocation(String prefix)

getAddableColumns

public List getAddableColumns()

getAvailableNavigatableFields

protected abstract List<NavigableField> getAvailableNavigatableFields()
                                                               throws FieldException

Throws:

FieldException

getSampleIssues

public List<Issue> getSampleIssues()

getPager

public PagerFilter getPager()

isFieldHidden

public boolean isFieldHidden(Long projectId,
                             String id,
                             String issueTypeId)

Checks if the field is hidden in the project with id of projectId and the issueType of issue with id of issueId.

Overrides:

isFieldHidden in class IssueActionSupport

Parameters:

projectId -

id - fieldId

getColumnLayout

protected abstract EditableColumnLayout getColumnLayout()

This function retrieve an editable column layout and assumes that the same object is returned during the lifetime of this object

getColumnLayoutManager

protected ColumnLayoutManager getColumnLayoutManager()