Package jetbrains.buildServer.web.reportTabs

Interface ReportTabManager

All Known Implementing Classes:

ReportTabManagerImpl, SecuredReportTabManager

public interface ReportTabManager

Interface ReportTabManager Interface for managing report tabs

Author:

nik, Oleg Rybak

Method Summary

Modifier and Type	Method	Description
void	createBuildReportTab(SProject project, String title, String startPage)	Created new build report tab
void	createProjectReportTab(String title, String startPage, SProject project, String buildTypeId, RevisionRule revisionRule)
void	deleteBuildReportTab(SProject project, ReportTabConfiguration configuration)	Deletes build report tab from given project
void	deleteProjectReportTab(SProject project, ProjectReportTabConfiguration configuration)
void	editBuildReportTab(SProject project, ReportTabConfiguration tab, String title, String startPage)
void	editProjectReportTab(SProject project, ProjectReportTabConfiguration tab, String title, String startPage, String buildTypeId, RevisionRule revisionRule)
ReportTabConfiguration	findTab(String tabId)
ReportTabConfiguration[]	getBuildReportTabConfigurations(SProject project)	Gets all configurations of build report tabs, defined in project with given projectId
ProjectReportTabConfiguration[]	getProjectReportTabs(SProject project)

Method Detail

getBuildReportTabConfigurations

@NotNull
ReportTabConfiguration[] getBuildReportTabConfigurations(@NotNull
                                                         SProject project)

Gets all configurations of build report tabs, defined in project with given projectId

Parameters:

project - project to get build report tabs configurations for

Returns:

all configurations of build report tabs

createBuildReportTab

void createBuildReportTab(@NotNull
                          SProject project,
                          @NotNull
                          String title,
                          @Nullable
                          String startPage)
                   throws DuplicateTabTitleException

Created new build report tab

Parameters:

projectId - project

title - title of the tab

startPage - page to display

Throws:

DuplicateTabTitleException - if tab with such title already exists

deleteBuildReportTab

void deleteBuildReportTab(@NotNull
                          SProject project,
                          @NotNull
                          ReportTabConfiguration configuration)

Deletes build report tab from given project

Parameters:

projectId - project

configuration - build report tab configuration

createProjectReportTab

void createProjectReportTab(@NotNull
                            String title,
                            @Nullable
                            String startPage,
                            @NotNull
                            SProject project,
                            @NotNull
                            String buildTypeId,
                            @NotNull
                            RevisionRule revisionRule)

deleteProjectReportTab

void deleteProjectReportTab(@NotNull
                            SProject project,
                            @NotNull
                            ProjectReportTabConfiguration configuration)

getProjectReportTabs

@NotNull
ProjectReportTabConfiguration[] getProjectReportTabs(@NotNull
                                                     SProject project)

findTab

@Nullable
ReportTabConfiguration findTab(@NotNull
                               String tabId)

editBuildReportTab

void editBuildReportTab(@NotNull
                        SProject project,
                        @NotNull
                        ReportTabConfiguration tab,
                        @NotNull
                        String title,
                        @Nullable
                        String startPage)

editProjectReportTab

void editProjectReportTab(@NotNull
                          SProject project,
                          @NotNull
                          ProjectReportTabConfiguration tab,
                          @NotNull
                          String title,
                          @Nullable
                          String startPage,
                          @NotNull
                          String buildTypeId,
                          @NotNull
                          RevisionRule revisionRule)