com.atlassian.jira.portal.portlets
Class AbstractSearchResultsPortlet

java.lang.Object
  extended by com.atlassian.jira.portal.PortletImpl
      extended by com.atlassian.jira.portal.portlets.AbstractRequiresUserPortlet
          extended by com.atlassian.jira.portal.portlets.AbstractSearchResultsPortlet
All Implemented Interfaces:
Portlet
Direct Known Subclasses:
AssignedToMePortlet, InProgressIssuesPortlet, SearchRequestPortlet

public abstract class AbstractSearchResultsPortlet
extends AbstractRequiresUserPortlet


Field Summary
protected  ConstantsManager constantsManager
           
protected static Collection DEFAULT_SEARCH_SORTS
           
protected  SearchProvider searchProvider
           
protected  TableLayoutFactory tableLayoutFactory
           
 
Fields inherited from class com.atlassian.jira.portal.PortletImpl
applicationProperties, authenticationContext, permissionManager
 
Constructor Summary
protected AbstractSearchResultsPortlet(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ConstantsManager constantsManager, SearchProvider searchProvider, ApplicationProperties applicationProperties)
          Deprecated. Use AbstractSearchResultsPortlet(com.atlassian.jira.security.JiraAuthenticationContext, com.atlassian.jira.security.PermissionManager, com.atlassian.jira.config.ConstantsManager, com.atlassian.jira.issue.search.SearchProvider, com.atlassian.jira.config.properties.ApplicationProperties, com.atlassian.jira.web.component.TableLayoutFactory) instead
protected AbstractSearchResultsPortlet(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ConstantsManager constantsManager, SearchProvider searchProvider, ApplicationProperties applicationProperties, TableLayoutFactory tableLayoutFactory)
           
 
Method Summary
protected  IssueTableLayoutBean getLayout(PortletConfiguration portletConfiguration)
          Override to provide your own column layouts
protected abstract  String getLinkToSearch(SearchRequest searchRequest, PortletConfiguration portletConfiguration)
           
protected  int getMaxNumberOfIssues(PortletConfiguration portletConfiguration)
           
protected abstract  String getNoIssuesText()
           
protected abstract  String getSearchName(SearchRequest searchRequest)
           
protected abstract  SearchRequest getSearchRequest(PortletConfiguration portletConfiguration)
           
protected abstract  String getSearchTypeName()
           
protected  Map getVelocityParams(PortletConfiguration portletConfiguration)
          Allow for the addition of additional Velocity parameters to the context.
 
Methods inherited from class com.atlassian.jira.portal.portlets.AbstractRequiresUserPortlet
getViewHtml
 
Methods inherited from class com.atlassian.jira.portal.PortletImpl
equals, getCornerThumbnail, getCornerThumbnailPath, getDescription, getDescriptor, getId, getIssueConstant, getListFromMultiSelectValue, getName, getObjectConfiguration, getPermission, getTemplateLocation, getThumbnailfile, getThumbnailPath, hashCode, hasPermission, init, isEditablePortletConfig
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_SEARCH_SORTS

protected static final Collection DEFAULT_SEARCH_SORTS

constantsManager

protected final ConstantsManager constantsManager

searchProvider

protected final SearchProvider searchProvider

tableLayoutFactory

protected final TableLayoutFactory tableLayoutFactory
Constructor Detail

AbstractSearchResultsPortlet

protected AbstractSearchResultsPortlet(JiraAuthenticationContext authenticationContext,
                                       PermissionManager permissionManager,
                                       ConstantsManager constantsManager,
                                       SearchProvider searchProvider,
                                       ApplicationProperties applicationProperties,
                                       TableLayoutFactory tableLayoutFactory)

AbstractSearchResultsPortlet

protected AbstractSearchResultsPortlet(JiraAuthenticationContext authenticationContext,
                                       PermissionManager permissionManager,
                                       ConstantsManager constantsManager,
                                       SearchProvider searchProvider,
                                       ApplicationProperties applicationProperties)
Deprecated. Use AbstractSearchResultsPortlet(com.atlassian.jira.security.JiraAuthenticationContext, com.atlassian.jira.security.PermissionManager, com.atlassian.jira.config.ConstantsManager, com.atlassian.jira.issue.search.SearchProvider, com.atlassian.jira.config.properties.ApplicationProperties, com.atlassian.jira.web.component.TableLayoutFactory) instead

this constructor is for backwards compatibility for old portlets

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

getLayout

protected IssueTableLayoutBean getLayout(PortletConfiguration portletConfiguration)
                                  throws FieldException
Override to provide your own column layouts

Throws:
FieldException

getMaxNumberOfIssues

protected int getMaxNumberOfIssues(PortletConfiguration portletConfiguration)

getSearchRequest

protected abstract SearchRequest getSearchRequest(PortletConfiguration portletConfiguration)

getLinkToSearch

protected abstract String getLinkToSearch(SearchRequest searchRequest,
                                          PortletConfiguration portletConfiguration)

getSearchName

protected abstract String getSearchName(SearchRequest searchRequest)

getSearchTypeName

protected abstract String getSearchTypeName()

getNoIssuesText

protected abstract String getNoIssuesText()


Copyright © 2002-2009 Atlassian. All Rights Reserved.