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

Interface ObjectSelectorParameter.Setter

All Known Subinterfaces:

ObjectSelectorParameter.Builder

Enclosing interface:

ObjectSelectorParameter

public static interface ObjectSelectorParameter.Setter

Method Summary

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

Method Details

prototype

@NotNull
PrototypeSelector<? extends ObjectSelectorParameter.Setter> prototype()

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

allowedPrototypes

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

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

allowedPrototypes

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

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

Throws:

IllegalArgumentException - if no value is specified or one of the specified values is not a name of constant from PrototypeEnum

NullPointerException - if one of the values is null

selectTemplates

@NotNull
ObjectSelectorParameter.Setter selectTemplates(boolean selectTemplates)

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.

Throws:

IllegalArgumentException - if selected allowed prototypes contains something else than Test Run or Plan.

allowedObjectsQuery

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

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.

objectPath

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

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

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.Setter current()

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

defaultQuery

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

Sets the default query for object picker dialog.

defaultSort

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

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

defaultColumns

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

Sets the default columns for object picker dialog.

Throws:

IllegalArgumentException - if no value is specified

NullPointerException - if one of the values is null

addCurrentScopeToDefaultQuery

@NotNull
ObjectSelectorParameter.Setter addCurrentScopeToDefaultQuery(boolean value)

Configures if the scope of the current Rich Page (or Plan, etc.) should be automatically added to the 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.