Package com.atlassian.bamboo.quickfilter.rule

Interface QuickFilterRule

All Superinterfaces:

BambooIdProvider, BambooObject, NameProvider, PluginKeyProvider

All Known Implementing Classes:

QuickFilterRuleEntity

public interface QuickFilterRule
extends BambooObject, NameProvider, PluginKeyProvider

Single rule used within a QuickFilter. Rules define whether plans do or do not match quick filters. A single quick filter may have multiple rules defined to filter plans.

Method Summary

Modifier and Type	Method	Description
@NotNull QuickFilterRule	copy()	Returns independent copy of this rule.
@NotNull QuickFilterRule	copy(@NotNull QuickFilter quickFilter)	Returns independent copy of this rule.
@NotNull Map<String,Object>	getConfiguration()	Configuration of this rule.
@NotNull String	getName()	User assigned name of this rule.
@NotNull String	getPluginKey()	Full plugin module key of this rule's type.
@NotNull QuickFilter	getQuickFilter()	Quick filter, for which this rule has been defined.
void	setConfiguration(@NotNull Map<String,Object> configuration)	Set configuration of this rule.
void	setName(@NotNull String name)	Set the user assigned name of this rule.
void	setPluginKey(@NotNull String pluginKey)	Set the full plugin module key of this rule's type.
void	setQuickFilter(@NotNull QuickFilter quickFilter)	Set quick filter to which this rule is to be assigned.

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Method Detail

getQuickFilter

@NotNull
@NotNull QuickFilter getQuickFilter()

Quick filter, for which this rule has been defined.

setQuickFilter

void setQuickFilter(@NotNull
                    @NotNull QuickFilter quickFilter)

Set quick filter to which this rule is to be assigned.

getPluginKey

@NotNull
@NotNull String getPluginKey()

Full plugin module key of this rule's type.

Specified by:

getPluginKey in interface PluginKeyProvider

Returns:

full plugin module key

setPluginKey

void setPluginKey(@NotNull
                  @NotNull String pluginKey)

Set the full plugin module key of this rule's type.

getName

@NotNull
@NotNull String getName()

User assigned name of this rule.

Specified by:

getName in interface NameProvider

setName

void setName(@NotNull
             @NotNull String name)

Set the user assigned name of this rule.

getConfiguration

@NotNull
@NotNull Map<String,Object> getConfiguration()

Configuration of this rule. Values may only be strings or lists of strings.

setConfiguration

void setConfiguration(@NotNull
                      @NotNull Map<String,Object> configuration)

Set configuration of this rule. Values may only be strings or lists of strings.

copy

@NotNull
@NotNull QuickFilterRule copy()

Returns independent copy of this rule.

copy

@NotNull
@NotNull QuickFilterRule copy(@NotNull
                              @NotNull QuickFilter quickFilter)

Returns independent copy of this rule.

Parameters:

quickFilter - quick filter to set as parent