com.atlassian.jira.web.action.browser
Class BrowseProjects

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport
              com.atlassian.jira.web.action.browser.BrowseProjects

All Implemented Interfaces:

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

public class BrowseProjects
extends JiraWebActionSupport

Action for Browse Projects

See Also:

Serialized Form

Nested Class Summary

static class

BrowseProjects.ProjectCategoryBean Simple bean that contains Project category information and its containing projects as GVS.

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.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, SUCCESS

Constructor Summary

BrowseProjects(com.atlassian.plugin.webresource.WebResourceManager webResourceManager, UserProjectHistoryManager projectHistoryManager, ProjectManager projectManager, PermissionManager permissionManager)

Method Summary

protected String	doExecute()
List<BrowseProjects.ProjectCategoryBean>	getCategories() Get the list of available categories as BrowseProjects.ProjectCategoryBean objects.
String	getSelectedCategory() Get the currently active Category.
List<BrowseProjects.ProjectCategoryBean>	getTabs()
void	setSelectedCategory(String selectedCategory) Places the given category in the session.
boolean	showTabs() Whether or not to show tabs.

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

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirectChecker, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, 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, getOfBizDelegator, getRemoteUser, 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, 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.util.ErrorCollection

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

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

BrowseProjects

public BrowseProjects(com.atlassian.plugin.webresource.WebResourceManager webResourceManager,
                      UserProjectHistoryManager projectHistoryManager,
                      ProjectManager projectManager,
                      PermissionManager permissionManager)

Method Detail

getSelectedCategory

public String getSelectedCategory()
                           throws org.ofbiz.core.entity.GenericEntityException

Get the currently active Category. Looks for it in the session, if it is "all" return it. Else, check to see if the category exists and we can see projects in it. Else, return the first category.

Returns:

the currently active category id, "all", "none" or "recent".

Throws:

org.ofbiz.core.entity.GenericEntityException - Sorry, yes we are using GVs.

setSelectedCategory

public void setSelectedCategory(String selectedCategory)

Places the given category in the session.

Parameters:

selectedCategory - the currently active category id, "all", "none" or "recent".

showTabs

public boolean showTabs()
                 throws org.ofbiz.core.entity.GenericEntityException

Whether or not to show tabs.

Returns:

true if we would show more than one tab.

Throws:

org.ofbiz.core.entity.GenericEntityException - Sorry, yes we are using GVs.

getTabs

public List<BrowseProjects.ProjectCategoryBean> getTabs()
                                                 throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getCategories

public List<BrowseProjects.ProjectCategoryBean> getCategories()
                                                       throws org.ofbiz.core.entity.GenericEntityException

Get the list of available categories as BrowseProjects.ProjectCategoryBean objects. These also contain the projects for that category.

We filter out categories with no visible projects.

We add a pseudo category for "none" No Category. We add a pseudo category for "Recent Projects" if there are 2 or more categories.

Returns:

the list of available categories

Throws:

org.ofbiz.core.entity.GenericEntityException - Sorry, yes we are using GVs.

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception