com.atlassian.jira.web.action.issue
Class IssueNavigator

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.ProjectActionSupport
                  extended by com.atlassian.jira.web.action.IssueActionSupport
                      extended by com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
                          extended by com.atlassian.jira.web.action.issue.IssueNavigator
All Implemented Interfaces:
ErrorCollection, I18nHelper, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class IssueNavigator
extends SearchDescriptionEnabledAction

See Also:
Serialized Form

Field Summary
static String MODE_HIDE
           
static String MODE_SHOW
           
protected  SearchRequestFactory searchRequestFactory
           
 
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, savedFilters, selectedProject
 
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
 
Fields inherited from interface com.atlassian.jira.util.I18nHelper
DEFAULT_RESOURCE_BUNDLE
 
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
IssueNavigator(SearchProvider searchProvider, ColumnLayoutManager columnLayoutManager, IssueSearcherManager issueSearcherManager, SearchRequestFactory searchRequestFactory, SearchRequestService searchRequestService, TableLayoutFactory tableLayoutFactory, CommentManager commentManager, com.atlassian.plugin.PluginManager pluginManager, ApplicationProperties applicationProperties)
           
 
Method Summary
 String doColumnOverride()
           
protected  String doExecute()
           
 SearchRequestViewModuleDescriptor getAllExcelFields()
           
 List getBrowsableItems()
          Return all issues matching the current filter, sorted.
 int getBulkEditMax()
          Returns the maximum number of issues the user is allowed to bulk edit.
 SearchRequestViewModuleDescriptor getChart()
           
 CommentManager getCommentManager()
           
 SearchRequestViewModuleDescriptor getCurrentExcelFields()
           
 SearchSort getFirstSorter()
           
 SearchRequestViewModuleDescriptor getFullContent()
           
 String getMode()
           
 PagerFilter getPager()
          Store the current pager in the session.
 SearchRequestViewModuleDescriptor getPrintable()
           
 String getRequestId()
           
 String getRestricted(String url)
           
 SearchRequestViewModuleDescriptor getRssComments()
           
 SearchRequestViewModuleDescriptor getRssIssues()
           
 String getSearcherEditHtml(IssueSearcher searcher)
           
 Collection getSearchRequestViews()
           
 SearchResults getSearchResults()
           
 String getSRQueryStringWithSorts()
           
 TableLayoutFactory getTableLayoutFactory()
           
 int getTempMax()
          Get / Set the temporary maximum - this is used for printable and excel views etc
 SearchRequestViewModuleDescriptor getWord()
           
 SearchRequestViewModuleDescriptor getXml()
           
 boolean isBulkEditLimited()
          Tells whether the bulk edit limit property is currently restricting the number of issues in the current search that may be bulk edited.
 boolean isHasBulkChangePermission()
          Checks to see if the current user has the global BULK CHANGE permission
 boolean isHasSearchRequestColumnLayout()
          Determines if the current search request has a column layout.
 boolean isOwnerOfSearchRequest()
           
 boolean isRequestPrivate()
           
 boolean isShowOverrideColumnLayout()
          Determines whether the "Use Your Columns" link should be shown to the user.
 boolean isValid()
           
 void resetPager()
           
protected  void setFieldValuesHolder(FieldValuesHolder fieldValuesHolder)
           
 void setHide(String value)
           
 void setMode(String mode)
          Control the mode (hide or show) of the left hand column
 void setShow(String value)
           
 void setTempMax(int tempMax)
           
 
Methods inherited from class com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
getActionParams, getFieldValuesHolder, getSearchContext, getSearcherGroups, getSearchers, getSearcherViewHtml, isFilterFavourite, isShown, populateFieldValuesHolderFromSR, validateSearchFilterIsSavedFilter
 
Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport
getAttachmentManager, getCustomFieldManager, getDaysPerWeek, getHoursPerDay, getIssueManager, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getSearchRequest, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isFieldHidden, isFieldHidden, isFieldHidden, setCurrentIssue, setSearchRequest, 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
addErrorCollection, forceRedirect, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRedirect, getRemoteUser, getReturnUrl, getSearchSortReverseDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUserFullName, getVersionManager, getWebworkStack, getWebworkStack, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isSystemAdministrator, isUserExists, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getApplicationProperties, getDefaultResourceBundle, getDelegator, getJiraLocaleUtils, getLocale, getResult, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doValidation, 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.util.ErrorCollection
addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
setCommand
 

Field Detail

MODE_SHOW

public static final String MODE_SHOW
See Also:
Constant Field Values

MODE_HIDE

public static final String MODE_HIDE
See Also:
Constant Field Values

searchRequestFactory

protected final SearchRequestFactory searchRequestFactory
Constructor Detail

IssueNavigator

public IssueNavigator(SearchProvider searchProvider,
                      ColumnLayoutManager columnLayoutManager,
                      IssueSearcherManager issueSearcherManager,
                      SearchRequestFactory searchRequestFactory,
                      SearchRequestService searchRequestService,
                      TableLayoutFactory tableLayoutFactory,
                      CommentManager commentManager,
                      com.atlassian.plugin.PluginManager pluginManager,
                      ApplicationProperties applicationProperties)
Method Detail

doExecute

protected String doExecute()
                    throws Exception
Overrides:
doExecute in class webwork.action.ActionSupport
Throws:
Exception

doColumnOverride

public String doColumnOverride()
                        throws Exception
Throws:
Exception

getFirstSorter

public SearchSort getFirstSorter()

getPager

public PagerFilter getPager()
Store the current pager in the session. The pager handles paging through the issue list.


getTableLayoutFactory

public TableLayoutFactory getTableLayoutFactory()

resetPager

public void resetPager()

getBrowsableItems

public List getBrowsableItems()
Return all issues matching the current filter, sorted.


getSearchResults

public SearchResults getSearchResults()
                               throws SearchException
Throws:
SearchException

getMode

public String getMode()

setMode

public void setMode(String mode)
Control the mode (hide or show) of the left hand column

Parameters:
mode - mode

setHide

public void setHide(String value)

setShow

public void setShow(String value)

getTempMax

public int getTempMax()
Get / Set the temporary maximum - this is used for printable and excel views etc

Returns:
temp max

setTempMax

public void setTempMax(int tempMax)

getSRQueryStringWithSorts

public String getSRQueryStringWithSorts()

isHasSearchRequestColumnLayout

public boolean isHasSearchRequestColumnLayout()
                                       throws ColumnLayoutStorageException
Determines if the current search request has a column layout. Used in the header of the IssueNavigator

Throws:
ColumnLayoutStorageException

isOwnerOfSearchRequest

public boolean isOwnerOfSearchRequest()

isShowOverrideColumnLayout

public boolean isShowOverrideColumnLayout()
                                   throws ColumnLayoutStorageException
Determines whether the "Use Your Columns" link should be shown to the user. This will happen IF the search request has its own column layout AND If the user has NOT chosen to override the search request's column layout

Throws:
ColumnLayoutStorageException

isHasBulkChangePermission

public boolean isHasBulkChangePermission()
Checks to see if the current user has the global BULK CHANGE permission


getSearcherEditHtml

public String getSearcherEditHtml(IssueSearcher searcher)

setFieldValuesHolder

protected void setFieldValuesHolder(FieldValuesHolder fieldValuesHolder)

isValid

public boolean isValid()

getRequestId

public String getRequestId()

isRequestPrivate

public boolean isRequestPrivate()

getCommentManager

public CommentManager getCommentManager()

getSearchRequestViews

public Collection getSearchRequestViews()

getPrintable

public SearchRequestViewModuleDescriptor getPrintable()

getFullContent

public SearchRequestViewModuleDescriptor getFullContent()

getXml

public SearchRequestViewModuleDescriptor getXml()

getRssIssues

public SearchRequestViewModuleDescriptor getRssIssues()

getRssComments

public SearchRequestViewModuleDescriptor getRssComments()

getWord

public SearchRequestViewModuleDescriptor getWord()

getAllExcelFields

public SearchRequestViewModuleDescriptor getAllExcelFields()

getCurrentExcelFields

public SearchRequestViewModuleDescriptor getCurrentExcelFields()

getChart

public SearchRequestViewModuleDescriptor getChart()

getRestricted

public String getRestricted(String url)

isBulkEditLimited

public boolean isBulkEditLimited()
Tells whether the bulk edit limit property is currently restricting the number of issues in the current search that may be bulk edited.

Returns:
true only if the bulk edit limit is restricting.

getBulkEditMax

public int getBulkEditMax()
Returns the maximum number of issues the user is allowed to bulk edit. Possibly the number of search results that were returned, but no more than the number configured by APKeys.JIRA_BULK_EDIT_LIMIT_ISSUE_COUNT if it is set to a positive number.

Returns:
the number of issues that can be bulk edited.


Copyright © 2002-2009 Atlassian. All Rights Reserved.