jetbrains.buildServer.web.openapi.project
Class BuildTypesBasedPortlet

java.lang.Object
  extended by jetbrains.buildServer.web.openapi.SimplePageExtension
      extended by jetbrains.buildServer.web.openapi.project.ProjectPortlet
          extended by jetbrains.buildServer.web.openapi.project.BuildTypesBasedPortlet
All Implemented Interfaces:
PageExtension

public abstract class BuildTypesBasedPortlet
extends ProjectPortlet

This is base class for project extensions which require a list of build types to operate

Author:
kir

Field Summary
 
Fields inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension
myCssPaths, myJsPaths, myPagePlaces
 
Constructor Summary
BuildTypesBasedPortlet(PagePlaces manager, ProjectManager projectManager, ProjectSettingsManager projectSettingsManager, PlaceId place, java.lang.String pluginName, java.lang.String includeUrl, java.lang.String modelObjectName)
           
 
Method Summary
protected abstract  Filter<SBuildType> createDefaultFilter()
           
protected  void fillModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request, SProject project, SUser user)
           
protected abstract  java.lang.String getSettingsKey()
          Return settings key, which is used in per-project configuration of the portlet
 boolean isAvailable(javax.servlet.http.HttpServletRequest request)
          Returns true if this extension is available (should be included on the page) for the specified request.
 
Methods inherited from class jetbrains.buildServer.web.openapi.project.ProjectPortlet
fillModel, getProject
 
Methods inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension
addCssFile, addJsFile, getCssPaths, getIncludeUrl, getJsPaths, getPlaceId, getPluginName, isGet, isPost, register, setIncludeUrl, setPlaceId, setPluginName, setPosition, toString, unregister
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BuildTypesBasedPortlet

public BuildTypesBasedPortlet(PagePlaces manager,
                              ProjectManager projectManager,
                              ProjectSettingsManager projectSettingsManager,
                              PlaceId place,
                              java.lang.String pluginName,
                              java.lang.String includeUrl,
                              java.lang.String modelObjectName)
Method Detail

getSettingsKey

protected abstract java.lang.String getSettingsKey()
Return settings key, which is used in per-project configuration of the portlet

Returns:
see above

isAvailable

public boolean isAvailable(@NotNull
                           javax.servlet.http.HttpServletRequest request)
Description copied from interface: PageExtension
Returns true if this extension is available (should be included on the page) for the specified request. If extension needs to be shown for some pages only, it can obtain original page URL via request attribute called "pageUrl":
String pageUrl = (String)request.getAttribute("pageUrl");

Specified by:
isAvailable in interface PageExtension
Overrides:
isAvailable in class ProjectPortlet
Parameters:
request - HTTP request
Returns:
true if extension should be included in the page place

fillModel

protected void fillModel(@NotNull
                         java.util.Map<java.lang.String,java.lang.Object> model,
                         @NotNull
                         javax.servlet.http.HttpServletRequest request,
                         @NotNull
                         SProject project,
                         SUser user)
Specified by:
fillModel in class ProjectPortlet

createDefaultFilter

protected abstract Filter<SBuildType> createDefaultFilter()