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

Interface ObjectSelectorParameter.Builder

All Superinterfaces:

ObjectSelectorParameter.Setter, RichPageParameter.Builder<ObjectSelectorParameter,ObjectSelectorParameter.Builder>

Enclosing interface:

ObjectSelectorParameter

public static interface ObjectSelectorParameter.Builder
extends ObjectSelectorParameter.Setter, RichPageParameter.Builder<ObjectSelectorParameter,ObjectSelectorParameter.Builder>

Method Summary

Modifier and Type	Method	Description
ObjectSelectorParameter.Builder	addCurrentScopeToDefaultQuery(boolean value)	Configures if the scope of the current Rich Page (or Plan, etc.) should be automatically added to the ObjectSelectorParameter.Setter.defaultQuery(String).
ObjectSelectorParameter.Builder	allowedObjectsQuery(String query)	Sets query limiting the allowed items.
ObjectSelectorParameter.Builder	allowedPrototypes(PrototypeEnum firstAllowed, PrototypeEnum... otherAllowed)	Sets which prototypes will be selectable by user, overrides values set by ObjectSelectorParameter.Setter.allowedPrototypes(Iterable) If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.
ObjectSelectorParameter.Builder	allowedPrototypes(Iterable<String> allowedPrototypes)	Sets which prototypes will be selectable by user, overrides values set by ObjectSelectorParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...) If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.
ObjectSelectorParameter.Builder	current()	Sets the selected object to the ObjectSelectorParameter.CURRENT, overrides value set by ObjectSelectorParameter.Setter.objectPath(String)
ObjectSelectorParameter.Builder	defaultColumns(Iterable<String> columns)	Sets the default columns for object picker dialog.
ObjectSelectorParameter.Builder	defaultQuery(String query)	Sets the default query for object picker dialog.
ObjectSelectorParameter.Builder	defaultSort(String sort)	Sets the default sorting for object picker dialog. The format is same as for ModelObjectsSearch.sort(String)
ObjectSelectorParameter.Builder	objectPath(String objectPath)	Sets the selected object, overrides value set by ObjectSelectorParameter.Setter.current()
PrototypeSelector<ObjectSelectorParameter.Builder>	prototype()	Selects target prototype for selector.
ObjectSelectorParameter.Builder	selectTemplates(boolean selectTemplates)	Configures that only templates can be selected.

Methods inherited from interface com.polarion.alm.shared.api.model.rp.parameter.RichPageParameter.Builder

build, dependencySource, dependencyTarget

Method Details

prototype

@NotNull
PrototypeSelector<ObjectSelectorParameter.Builder> prototype()

Description copied from interface: ObjectSelectorParameter.Setter

Selects target prototype for selector. If target prototype is not contained in allowed prototypes then it is added automatically.

Specified by:

prototype in interface ObjectSelectorParameter.Setter

allowedPrototypes

@NotNull
ObjectSelectorParameter.Builder allowedPrototypes(@NotNull
 PrototypeEnum firstAllowed,
 @Nullable
 PrototypeEnum... otherAllowed)

Description copied from interface: ObjectSelectorParameter.Setter

Sets which prototypes will be selectable by user, overrides values set by ObjectSelectorParameter.Setter.allowedPrototypes(Iterable) If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.

Specified by:

allowedPrototypes in interface ObjectSelectorParameter.Setter

allowedPrototypes

@NotNull
ObjectSelectorParameter.Builder allowedPrototypes(@NotNull
 Iterable<String> allowedPrototypes)

Description copied from interface: ObjectSelectorParameter.Setter

Sets which prototypes will be selectable by user, overrides values set by ObjectSelectorParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...) If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.

Specified by:

allowedPrototypes in interface ObjectSelectorParameter.Setter

selectTemplates

@NotNull
ObjectSelectorParameter.Builder selectTemplates(boolean selectTemplates)

Description copied from interface: ObjectSelectorParameter.Setter

Configures that only templates can be selected. Default value is false.
Can be set to true only if allowed prototypes contains only Test Run or Plan.

Specified by:

selectTemplates in interface ObjectSelectorParameter.Setter

allowedObjectsQuery

@NotNull
ObjectSelectorParameter.Builder allowedObjectsQuery(@Nullable
 String query)

Description copied from interface: ObjectSelectorParameter.Setter

Sets query limiting the allowed items. When the object selected by user does not match this query, then the ObjectSelectorParameter.value() returns null.

Null or empty string query means there is no limit so all objects are allowed.

Specified by:

allowedObjectsQuery in interface ObjectSelectorParameter.Setter

objectPath

@NotNull
ObjectSelectorParameter.Builder objectPath(@Nullable
 String objectPath)

Description copied from interface: ObjectSelectorParameter.Setter

Sets the selected object, overrides value set by ObjectSelectorParameter.Setter.current()

Specified by:

objectPath in interface ObjectSelectorParameter.Setter

Parameters:

objectPath - - absolute path as returned by ModelObjectReference.toPath() or path relative to current page or container object as returned by HasRelativePath.toRelativePath(String) or HasNameAndSpaceReference.toSpaceRelativePath(SpaceReference). Empty string is treated as null, ObjectSelectorParameter.CURRENT can be used to refer to current page or container object.

current

@NotNull
ObjectSelectorParameter.Builder current()

Description copied from interface: ObjectSelectorParameter.Setter

Sets the selected object to the ObjectSelectorParameter.CURRENT, overrides value set by ObjectSelectorParameter.Setter.objectPath(String)

Specified by:

current in interface ObjectSelectorParameter.Setter

defaultQuery

@NotNull
ObjectSelectorParameter.Builder defaultQuery(@Nullable
 String query)

Description copied from interface: ObjectSelectorParameter.Setter

Sets the default query for object picker dialog.

Specified by:

defaultQuery in interface ObjectSelectorParameter.Setter

defaultSort

@NotNull
ObjectSelectorParameter.Builder defaultSort(@Nullable
 String sort)

Description copied from interface: ObjectSelectorParameter.Setter

Sets the default sorting for object picker dialog.
The format is same as for ModelObjectsSearch.sort(String)

Specified by:

defaultSort in interface ObjectSelectorParameter.Setter

defaultColumns

@NotNull
ObjectSelectorParameter.Builder defaultColumns(@NotNull
 Iterable<String> columns)

Description copied from interface: ObjectSelectorParameter.Setter

Sets the default columns for object picker dialog.

Specified by:

defaultColumns in interface ObjectSelectorParameter.Setter

addCurrentScopeToDefaultQuery

@NotNull
ObjectSelectorParameter.Builder addCurrentScopeToDefaultQuery(boolean value)

Description copied from interface: ObjectSelectorParameter.Setter

Configures if the scope of the current Rich Page (or Plan, etc.) should be automatically added to the ObjectSelectorParameter.Setter.defaultQuery(String). If true than the following query is added: ' AND project.id:{current project id}' if the page is in the project.

The value is ignored if the selected prototype is Project or User.

Specified by:

addCurrentScopeToDefaultQuery in interface ObjectSelectorParameter.Setter