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

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.browser.BrowseProjects
All Implemented Interfaces:
ErrorCollection, I18nHelper, java.io.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.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)
           
 
Method Summary
protected  java.lang.String doExecute()
           
 java.util.List<BrowseProjects.ProjectCategoryBean> getCategories()
          Get the list of available categories as BrowseProjects.ProjectCategoryBean objects.
 java.lang.String getSelectedCategory()
          Get the currently active Category.
 java.util.List<BrowseProjects.ProjectCategoryBean> getTabs()
           
 void setSelectedCategory(java.lang.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
addErrorCollection, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, forceRedirect, getApplicationProperties, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRandomHint, getRedirect, getRemoteUser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUriValidator, getUserFullName, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, setConglomerateCookieValue, setInline, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getDefaultResourceBundle, getDelegator, getKeysForPrefix, getLocale, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText0, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, 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)
Method Detail

getSelectedCategory

public java.lang.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(java.lang.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 java.util.List<BrowseProjects.ProjectCategoryBean> getTabs()
                                                           throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

getCategories

public java.util.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 java.lang.String doExecute()
                              throws java.lang.Exception
Overrides:
doExecute in class webwork.action.ActionSupport
Throws:
java.lang.Exception


Copyright © 2002-2010 Atlassian. All Rights Reserved.