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 TypeMethodDescriptionaddCurrentScopeToDefaultQuery
(boolean value) Configures if the scope of the current Rich Page (or Plan, etc.) should be automatically added to theObjectSelectorParameter.Setter.defaultQuery(String)
.allowedObjectsQuery
(String query) Sets query limiting the allowed items.allowedPrototypes
(PrototypeEnum firstAllowed, PrototypeEnum... otherAllowed) Sets which prototypes will be selectable by user, overrides values set byObjectSelectorParameter.Setter.allowedPrototypes(Iterable)
If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.allowedPrototypes
(Iterable<String> allowedPrototypes) Sets which prototypes will be selectable by user, overrides values set byObjectSelectorParameter.Setter.allowedPrototypes(PrototypeEnum, PrototypeEnum...)
If allowed prototypes does not contain target prototype then first allowed prototype is selected as target prototype automatically.current()
Sets the selected object to theObjectSelectorParameter.CURRENT
, overrides value set byObjectSelectorParameter.Setter.objectPath(String)
defaultColumns
(Iterable<String> columns) Sets the default columns for object picker dialog.defaultQuery
(String query) Sets the default query for object picker dialog.defaultSort
(String sort) Sets the default sorting for object picker dialog.
The format is same as forModelObjectsSearch.sort(String)
objectPath
(String objectPath) Sets the selected object, overrides value set byObjectSelectorParameter.Setter.current()
Selects target prototype for selector.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
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 interfaceObjectSelectorParameter.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 byObjectSelectorParameter.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 interfaceObjectSelectorParameter.Setter
-
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 interfaceObjectSelectorParameter.Setter
-
allowedObjectsQuery
Description copied from interface:ObjectSelectorParameter.Setter
Sets query limiting the allowed items. When the object selected by user does not match this query, then theObjectSelectorParameter.value()
returns null.
Null or empty string query means there is no limit so all objects are allowed.- Specified by:
allowedObjectsQuery
in interfaceObjectSelectorParameter.Setter
-
objectPath
Description copied from interface:ObjectSelectorParameter.Setter
Sets the selected object, overrides value set byObjectSelectorParameter.Setter.current()
- Specified by:
objectPath
in interfaceObjectSelectorParameter.Setter
- Parameters:
objectPath
- - absolute path as returned byModelObjectReference.toPath()
or path relative to current page or container object as returned byHasRelativePath.toRelativePath(String)
orHasNameAndSpaceReference.toSpaceRelativePath(SpaceReference)
. Empty string is treated as null,ObjectSelectorParameter.CURRENT
can be used to refer to current page or container object.
-
current
Description copied from interface:ObjectSelectorParameter.Setter
Sets the selected object to theObjectSelectorParameter.CURRENT
, overrides value set byObjectSelectorParameter.Setter.objectPath(String)
- Specified by:
current
in interfaceObjectSelectorParameter.Setter
-
defaultQuery
Description copied from interface:ObjectSelectorParameter.Setter
Sets the default query for object picker dialog.- Specified by:
defaultQuery
in interfaceObjectSelectorParameter.Setter
-
defaultSort
Description copied from interface:ObjectSelectorParameter.Setter
Sets the default sorting for object picker dialog.
The format is same as forModelObjectsSearch.sort(String)
- Specified by:
defaultSort
in interfaceObjectSelectorParameter.Setter
-
defaultColumns
Description copied from interface:ObjectSelectorParameter.Setter
Sets the default columns for object picker dialog.- Specified by:
defaultColumns
in interfaceObjectSelectorParameter.Setter
-
addCurrentScopeToDefaultQuery
Description copied from interface:ObjectSelectorParameter.Setter
Configures if the scope of the current Rich Page (or Plan, etc.) should be automatically added to theObjectSelectorParameter.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 interfaceObjectSelectorParameter.Setter
-