com.deiser.jira.profields.api.layout

Interface LayoutService

public interface LayoutService

Layout service

Method Summary

Modifier and Type	Method and Description
void	associateToProject(Layout layout, Long projectId) Associate a layout to a project.
Layout	create(LayoutBuilder layoutBuilder) Create the layout.
void	delete(Layout layout) Delete the layout.
void	disassociateLayoutsToProject(Long projectId) Disassociate layout from a project
void	disassociateToProject(Layout layout, Long projectId) Disassociate a layout from a project.
List<Layout>	get() Get the list of layouts.
Layout	get(Integer id) Get the layout by id.
List<com.atlassian.jira.project.Project>	getAvailableProjects() Get the projects that do not have a layout associated.
Layout	getByName(String name) Get the layout by name.
Layout	getByProject(com.atlassian.jira.project.Project project) Get the layout of the project.
ContainerViewBuilder	getContainerViewBuilder() Gets container view builder.
ContainerViewBuilder	getContainerViewBuilderFrom(ContainerView containerView) Get container view builder from a container
Layout	getDefault(com.atlassian.jira.project.type.ProjectType projectType) Return the default layout for a project type
Layout	getDefaultEmptyLayout() Return the default empty layout
FieldViewBuilder	getFieldViewBuilder() Get field view builder.
FieldViewBuilder	getFieldViewBuilderFrom(FieldView fieldView) Get field view builder
LayoutBuilder	getLayoutBuilder() Get the layout builder.
List<com.atlassian.jira.project.Project>	getProjects(Layout layout) Get the list of projects that have the layout.
List<com.atlassian.jira.project.Project>	getProjectsWithPredefinedLayout(Layout layout) Get the list of projects that have the layout.
SectionViewBuilder	getSectionViewBuilder() Gets section view builder.
SectionViewBuilder	getSectionViewBuilderFrom(SectionView sectionView) Get section view builder from a section
List<SectionViewBuilder>	getSectionViewBuildersFrom(Layout layout) Get all section view builders from layout
List<SectionViewBuilder>	getSectionViewBuildersFrom(List<SectionView> sectionViews) Get section view builders from a section list
List<com.atlassian.jira.project.Project>	getUnassociatedProjects(Layout layout) Get the list of projects those don't have this associated layout.
List<com.atlassian.jira.project.Project>	getUnavailableProjects() Get the projects that have a layout.
void	removeDefault(com.atlassian.jira.project.type.ProjectType projectType) Remove the default layout for a project type
void	setDefault(com.atlassian.jira.project.type.ProjectType projectType, Integer layoutId) Deprecated.
void	setDefault(com.atlassian.jira.project.type.ProjectType projectType, Layout layout) Set the default layout for a project type
void	update(Layout layout) Update the layout.

Method Detail

getLayoutBuilder

LayoutBuilder getLayoutBuilder()

Get the layout builder.

Returns:

the layout builder

getSectionViewBuilder

SectionViewBuilder getSectionViewBuilder()

Gets section view builder.

Returns:

the section view builder

getSectionViewBuilderFrom

SectionViewBuilder getSectionViewBuilderFrom(SectionView sectionView)

Get section view builder from a section

Parameters:

sectionView -

Returns:

the section view builder

getSectionViewBuildersFrom

List<SectionViewBuilder> getSectionViewBuildersFrom(List<SectionView> sectionViews)

Get section view builders from a section list

Parameters:

sectionViews -

Returns:

list of section view builders

getSectionViewBuildersFrom

List<SectionViewBuilder> getSectionViewBuildersFrom(Layout layout)

Get all section view builders from layout

Parameters:

layout -

Returns:

list of section view builders

getContainerViewBuilder

ContainerViewBuilder getContainerViewBuilder()

Gets container view builder.

Returns:

the container view builder

getContainerViewBuilderFrom

ContainerViewBuilder getContainerViewBuilderFrom(ContainerView containerView)

Get container view builder from a container

Parameters:

containerView -

Returns:

the container view builder

getFieldViewBuilder

FieldViewBuilder getFieldViewBuilder()

Get field view builder.

Returns:

the field view builder

getFieldViewBuilderFrom

FieldViewBuilder getFieldViewBuilderFrom(FieldView fieldView)

Get field view builder

Parameters:

fieldView -

Returns:

the field view builder

create

Layout create(LayoutBuilder layoutBuilder)

Create the layout.

Parameters:

layoutBuilder - the layout builder

Returns:

the layout created

get

List<Layout> get()

Get the list of layouts.

Returns:

the list of layouts

get

Layout get(Integer id)

Get the layout by id.

Parameters:

id - the id of the layout

Returns:

the layout

getByName

Layout getByName(String name)

Get the layout by name.

Parameters:

name - the name of the layout

Returns:

the layout

getByProject

Layout getByProject(com.atlassian.jira.project.Project project)

Get the layout of the project. If the project doesn't have any layout, It gets the default empty layout.

Parameters:

project - the project

Returns:

the layout of the project

getProjects

List<com.atlassian.jira.project.Project> getProjects(Layout layout)

Get the list of projects that have the layout. The layout predefined will not be taken to get the projects due to this layout has not associated projects.

Parameters:

layout - the layout

Returns:

the list of projects that have the layout

getProjectsWithPredefinedLayout

List<com.atlassian.jira.project.Project> getProjectsWithPredefinedLayout(Layout layout)

Get the list of projects that have the layout. If the layout is a predefined, it return the projects without layout associated.

Parameters:

layout - the layout

Returns:

the list of projects that have the layout

getUnassociatedProjects

List<com.atlassian.jira.project.Project> getUnassociatedProjects(Layout layout)

Get the list of projects those don't have this associated layout.

Parameters:

layout -

Returns:

the list of projects those don't have this layout.

getAvailableProjects

List<com.atlassian.jira.project.Project> getAvailableProjects()

Get the projects that do not have a layout associated.

Returns:

the list of projects available

getUnavailableProjects

List<com.atlassian.jira.project.Project> getUnavailableProjects()

Get the projects that have a layout.

Returns:

the list of projects unavailable

update

void update(Layout layout)

Update the layout.

Parameters:

layout - the layout to be updated

delete

void delete(Layout layout)

Delete the layout.

Parameters:

layout - the layout to be deleted

associateToProject

void associateToProject(Layout layout,
                        Long projectId)

Associate a layout to a project.

Parameters:

layout - the layout to be associated

projectId - the project id

disassociateToProject

void disassociateToProject(Layout layout,
                           Long projectId)

Disassociate a layout from a project.

Parameters:

layout - the layout to be disassociate

projectId - the project id

disassociateLayoutsToProject

void disassociateLayoutsToProject(Long projectId)

Disassociate layout from a project

Parameters:

projectId - the project id

getDefault

Layout getDefault(com.atlassian.jira.project.type.ProjectType projectType)

Return the default layout for a project type

Parameters:

projectType - the project type

Returns:

the default layout for this project type

setDefault

@Deprecated
void setDefault(com.atlassian.jira.project.type.ProjectType projectType,
                            Integer layoutId)

Deprecated.

Set the default layout for a project type

Parameters:

projectType - the project type

layoutId - the id of default layout

setDefault

void setDefault(com.atlassian.jira.project.type.ProjectType projectType,
                Layout layout)

Set the default layout for a project type

Parameters:

projectType - the project type

layout - default layout

removeDefault

void removeDefault(com.atlassian.jira.project.type.ProjectType projectType)

Remove the default layout for a project type

Parameters:

projectType - the project type

getDefaultEmptyLayout

Layout getDefaultEmptyLayout()

Return the default empty layout

Returns:

the default layout for this project type