Package com.polarion.alm.tracker.model

Interface IModuleHomePageBuilder

public interface IModuleHomePageBuilder

Builder of the module (document) home page content. It is intended for use by clients that need to create the whole home page at once, from top to bottom. Therefore inserting on specific places is not supported. Only work items and headings are supported now. Purpose of this API is connector to 3rd party clients and it should not be used as substitute for Documents API.

Since:

3.10.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IModuleHomePageBuilder.IHeadingBuilder
static interface	IModuleHomePageBuilder.IWorkItemBuilder

Method Summary

Modifier and Type	Method	Description
IModuleHomePageBuilder.IHeadingBuilder	heading(IWorkItem workItem)	Returns the builder for the heading placeholder.
void	set()	Sets the home page content to the module and closes this builder.
IModuleHomePageBuilder.IWorkItemBuilder	workItem(IWorkItem workItem)	Returns the builder for the work item placeholder.

Method Details

heading

@NotNull
IModuleHomePageBuilder.IHeadingBuilder heading(@NotNull
 IWorkItem workItem)

Returns the builder for the heading placeholder. Method IModuleHomePageBuilder.IHeadingBuilder.add() must be called to actually add the heading.

workItem

@NotNull
IModuleHomePageBuilder.IWorkItemBuilder workItem(@NotNull
 IWorkItem workItem)

Returns the builder for the work item placeholder. Method IModuleHomePageBuilder.IWorkItemBuilder.add() must be called to actually add the work item.

set

void set()

Sets the home page content to the module and closes this builder. No method can be called on this instance after this method is called.