com.atlassian.bamboo.quickfilter

Class QuickFilterEntity

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.bamboo.quickfilter.QuickFilterEntity

All Implemented Interfaces:

BambooIdProvider, BambooObject, QuickFilter, NameProvider, Cloneable

public class QuickFilterEntity
extends com.atlassian.core.bean.EntityObject
implements QuickFilter

Constructor Summary

Constructors

Constructor and Description
QuickFilterEntity(String name)

Method Summary

Modifier and Type	Method and Description
QuickFilterEntity	copy() Returns independent copy of this quick filter.
String	getName() Get the unique name of this quick filter.
int	getPosition() Get the position of this quick filter on the quick filters list.
List<QuickFilterRule>	getRules() Returns a list of rules for this quick filter.
void	setName(String name) Set quick filter's unique name.
void	setPosition(int position) Sets the position of this quick filter on the quick filters list.
void	setRules(List<QuickFilterRule> rules) Set the rules for this quick filter.

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getId, getLastModificationDate, hashCode, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

setId

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

getId

Constructor Detail

QuickFilterEntity

public QuickFilterEntity(@NotNull
                         String name)

Method Detail

copy

@NotNull
public QuickFilterEntity copy()

Description copied from interface: QuickFilter

Returns independent copy of this quick filter.

Specified by:

copy in interface QuickFilter

getName

@NotNull
public String getName()

Description copied from interface: QuickFilter

Get the unique name of this quick filter. The name is also filter's display name.

Specified by:

getName in interface QuickFilter

Specified by:

getName in interface NameProvider

Returns:

quick filter name

setName

public void setName(@NotNull
                    String name)

Description copied from interface: QuickFilter

Set quick filter's unique name. The name is also filter's display name

Specified by:

setName in interface QuickFilter

Parameters:

name - new name of this quick filter

getPosition

public int getPosition()

Description copied from interface: QuickFilter

Get the position of this quick filter on the quick filters list. This value indicates the order of displaying filters to users. First quick filter should have position of 1.

Specified by:

getPosition in interface QuickFilter

Returns:

quick filter position on the list

setPosition

public void setPosition(int position)

Description copied from interface: QuickFilter

Sets the position of this quick filter on the quick filters list. This value indicates the order of displaying filters to users. First quick filter should have position of 1.

Specified by:

setPosition in interface QuickFilter

Parameters:

position - new quick filter position index

getRules

@NotNull
public List<QuickFilterRule> getRules()

Description copied from interface: QuickFilter

Returns a list of rules for this quick filter. Rules define whether a quick filter will or will not match a plan.

Specified by:

getRules in interface QuickFilter

Returns:

quick filter rules

setRules

public void setRules(@NotNull
                     List<QuickFilterRule> rules)

Description copied from interface: QuickFilter

Set the rules for this quick filter. Rules define whether a quick filter will or will not match a plan.

Specified by:

setRules in interface QuickFilter

Parameters:

rules - quick filter rules