com.atlassian.jira.portal.portlets
Class ProjectTablePortlet

java.lang.Object
  extended by com.atlassian.jira.portal.PortletImpl
      extended by com.atlassian.jira.portal.portlets.ProjectTablePortlet
All Implemented Interfaces:
Portlet

public class ProjectTablePortlet
extends PortletImpl

Portlet with a list of projects or project categories in a table with a configured list of columns.

Since:
v3.13

Field Summary
 
Fields inherited from class com.atlassian.jira.portal.PortletImpl
applicationProperties, authenticationContext, permissionManager
 
Constructor Summary
ProjectTablePortlet(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ApplicationProperties applicationProperties, ProjectManager projectManager)
           
 
Method Summary
 Collection getBrowseableProjects()
           
 Collection getBrowseableProjectsInCategory(org.ofbiz.core.entity.GenericValue category)
          Retrieves a list of projects belonging to the specified category that the user has permission to see
 Collection getBrowseableProjectsWithNoCategory()
           
 org.ofbiz.core.entity.GenericValue getProjectCategoryGv(PortletConfiguration portletConfiguration)
          Retrieves the single select project category as a generic value.
protected  Map getVelocityParams(PortletConfiguration portletConfiguration)
          Allow for the addition of additional Velocity parameters to the context.
 boolean showSignup()
          Tells whether to show signup link, true only if exteneral user management is off and JIRA is in public mode.
 
Methods inherited from class com.atlassian.jira.portal.PortletImpl
equals, getCornerThumbnail, getCornerThumbnailPath, getDescription, getDescriptor, getId, getIssueConstant, getListFromMultiSelectValue, getName, getObjectConfiguration, getPermission, getTemplateLocation, getThumbnailfile, getThumbnailPath, getViewHtml, hashCode, hasPermission, init, isEditablePortletConfig
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProjectTablePortlet

public ProjectTablePortlet(JiraAuthenticationContext authenticationContext,
                           PermissionManager permissionManager,
                           ApplicationProperties applicationProperties,
                           ProjectManager projectManager)
Method Detail

getVelocityParams

protected Map getVelocityParams(PortletConfiguration portletConfiguration)
Description copied from class: PortletImpl
Allow for the addition of additional Velocity parameters to the context. Sub-classes may wish to override this to add their own object to the velocity context

Overrides:
getVelocityParams in class PortletImpl
Parameters:
portletConfiguration - portlet configuration
Returns:
map of velocity parameters, never null

getBrowseableProjectsInCategory

public Collection getBrowseableProjectsInCategory(org.ofbiz.core.entity.GenericValue category)
                                           throws org.ofbiz.core.entity.GenericEntityException
Retrieves a list of projects belonging to the specified category that the user has permission to see

Parameters:
category - specify the category or null to retrieve a list of browseable projects that are not associated with any category
Returns:
collection of project generic values
Throws:
org.ofbiz.core.entity.GenericEntityException - if cannot retrieve projects

getBrowseableProjectsWithNoCategory

public Collection getBrowseableProjectsWithNoCategory()
                                               throws org.ofbiz.core.entity.GenericEntityException
Throws:
org.ofbiz.core.entity.GenericEntityException

getBrowseableProjects

public Collection getBrowseableProjects()

getProjectCategoryGv

public org.ofbiz.core.entity.GenericValue getProjectCategoryGv(PortletConfiguration portletConfiguration)
Retrieves the single select project category as a generic value. If allCategories are requested, this will return null or if the projectCategoryId doesn't match an existing project category, this will return null. TODO: Replace GV with ProjectCategory domain object when it is created

Parameters:
portletConfiguration - contains the projectCategoryId parameter.
Returns:
the project category or null if no single project category is configured in the portletConfiguration.

showSignup

public boolean showSignup()
Tells whether to show signup link, true only if exteneral user management is off and JIRA is in public mode.

Returns:
true only if the link to signup should be shown given current JIRA config.


Copyright © 2002-2009 Atlassian. All Rights Reserved.