Package com.polarion.alm.shared.api.model.rp

Interface RichPageSelector<T>

All Superinterfaces:

ModelObjectSelector<T,RichPageSelector<T>,RichPageReference>

public interface RichPageSelector<T>
extends ModelObjectSelector<T,RichPageSelector<T>,RichPageReference>

Interface for selecting the rich page using optional project id and revision and mandatory page path or space id and page name. The selection is finished by using path(String), spaceAndName(String, String) or spaceReferenceAndName(SpaceReference, String) method and the selector object cannot be used anymore after that.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
T	path(String pagePath)	Finishes selecting the page using the relative path to page.
RichPageSelector<T>	project(String projectId)	Optionally specify a project, must be used before path(String) or spaceAndName(String, String), the value is ignored when used before spaceReferenceAndName(SpaceReference, String)
T	spaceAndName(String spaceId, String pageName)	Finishes selecting the page using the space path and page name as separate parameters.
T	spaceReferenceAndName(SpaceReference space, String pageName)	Finishes selecting the page using the space reference and page name, value given to the project(String) method is ignored, because the SpaceReference already contains it.

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObjectSelector

oldApiObject, reference, revision

Method Details

project

@NotNull
RichPageSelector<T> project(@Nullable
 String projectId)

Optionally specify a project, must be used before path(String) or spaceAndName(String, String), the value is ignored when used before spaceReferenceAndName(SpaceReference, String)

Returns:

returns the same instance to allow method chaining

Throws:

IllegalStateException - after the selection was finished

path

@NotNull
T path(@NotNull
 String pagePath)

Finishes selecting the page using the relative path to page.

Specified by:

path in interface ModelObjectSelector<T,RichPageSelector<T>,RichPageReference>

Parameters:

pagePath - - the value as returned by RichPageReference.toPath()

Throws:

IllegalStateException - after the selection was finished

spaceAndName

@NotNull
T spaceAndName(@Nullable
 String spaceId,
 @NotNull
 String pageName)

Finishes selecting the page using the space path and page name as separate parameters.

Parameters:

spaceId - - The space id as returned by SpaceReference.spaceId()

Throws:

IllegalStateException - after the selection was finished

spaceReferenceAndName

@NotNull
T spaceReferenceAndName(@NotNull
 SpaceReference space,
 @NotNull
 String pageName)

Finishes selecting the page using the space reference and page name, value given to the project(String) method is ignored, because the SpaceReference already contains it.

Throws:

IllegalStateException - after the selection was finished