com.pyxis.greenhopper.jira.configurations.context
Interface Filter

All Known Implementing Classes:
FilterOption, NoFilterOption, SortOnlyOption

public interface Filter

Describes a filter (either view or highlight) for a GreenHopper context. Filters are applied to Board queries to further filter issues according to user defined settings.


Field Summary
static java.lang.String FILTER
           
static java.lang.String HIGHLIGHT
           
static Filter NONE
           
 
Method Summary
 com.atlassian.jira.jql.builder.JqlQueryBuilder apply(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.jql.builder.JqlQueryBuilder queryBuilder, boolean generatePrettyQuery)
          Apply the filter onto a given query.
 com.atlassian.query.Query apply(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, boolean byNames)
           
 java.util.Collection<java.lang.String> getAssigneeFilter()
           
 java.util.Collection<java.lang.String> getComponentFilter()
           
 java.util.Collection<java.lang.Long> getJiraFilter()
           
 java.util.TreeSet<com.atlassian.jira.issue.search.SearchRequest> getJiraFilters()
           
 java.util.Collection<java.lang.String> getPriorityFilter()
           
 java.util.Collection<java.lang.String> getStatusFilter()
           
 java.util.Collection<java.lang.String> getTypeFilter()
           
 boolean isDoneFilterOn()
          Needed for calculations in the quick filter.
 boolean isFilterOn()
          Deprecated. 
 boolean isJiraFilterSelected()
           
 boolean isNoCmptSelected()
           
 boolean isPersonalFilterOn()
          Needed for calculations in the quick filter.
 boolean isUnresolvedFilterOn()
           
 void setAssigneeFiter(java.util.Collection<java.lang.String> assigneeFilter)
           
 void setComponentFilter(java.util.Collection<java.lang.String> componentFilters)
           
 void setDoneFilterOn(java.lang.Boolean doneFilterOn)
           
 void setFilterOn(java.lang.Boolean filterOn)
          Deprecated. 
 void setJiraFilter(java.util.Collection<java.lang.Long> filterIds)
           
 void setPersonalFilterOn(java.lang.Boolean personalFilterOn)
           
 void setPriotityFilter(java.util.Collection<java.lang.String> priorityFilters)
           
 void setStatusFilter(java.util.Collection<java.lang.String> statusFilters)
           
 void setTypeFiter(java.util.Collection<java.lang.String> typeFilters)
           
 void setUnresolvedFilterOn(java.lang.Boolean unresolvedFilterOn)
           
 void trash()
           
 

Field Detail

NONE

static final Filter NONE

FILTER

static final java.lang.String FILTER
See Also:
Constant Field Values

HIGHLIGHT

static final java.lang.String HIGHLIGHT
See Also:
Constant Field Values
Method Detail

apply

com.atlassian.query.Query apply(com.atlassian.crowd.embedded.api.User user,
                                com.atlassian.query.Query query,
                                boolean byNames)

apply

com.atlassian.jira.jql.builder.JqlQueryBuilder apply(com.atlassian.crowd.embedded.api.User user,
                                                     com.atlassian.jira.jql.builder.JqlQueryBuilder queryBuilder,
                                                     boolean generatePrettyQuery)
Apply the filter onto a given query.

Returns:
a query object that has the filter applied to it.

isDoneFilterOn

boolean isDoneFilterOn()
Needed for calculations in the quick filter.


isPersonalFilterOn

boolean isPersonalFilterOn()
Needed for calculations in the quick filter.


isFilterOn

@Deprecated
boolean isFilterOn()
Deprecated. 


isJiraFilterSelected

boolean isJiraFilterSelected()

isNoCmptSelected

boolean isNoCmptSelected()

isUnresolvedFilterOn

boolean isUnresolvedFilterOn()

getTypeFilter

java.util.Collection<java.lang.String> getTypeFilter()

getPriorityFilter

java.util.Collection<java.lang.String> getPriorityFilter()

getComponentFilter

java.util.Collection<java.lang.String> getComponentFilter()

getStatusFilter

java.util.Collection<java.lang.String> getStatusFilter()

getAssigneeFilter

java.util.Collection<java.lang.String> getAssigneeFilter()

getJiraFilters

java.util.TreeSet<com.atlassian.jira.issue.search.SearchRequest> getJiraFilters()

getJiraFilter

java.util.Collection<java.lang.Long> getJiraFilter()

setFilterOn

@Deprecated
void setFilterOn(java.lang.Boolean filterOn)
Deprecated. 


setUnresolvedFilterOn

void setUnresolvedFilterOn(java.lang.Boolean unresolvedFilterOn)

setDoneFilterOn

void setDoneFilterOn(java.lang.Boolean doneFilterOn)

setPersonalFilterOn

void setPersonalFilterOn(java.lang.Boolean personalFilterOn)

setTypeFiter

void setTypeFiter(java.util.Collection<java.lang.String> typeFilters)

setPriotityFilter

void setPriotityFilter(java.util.Collection<java.lang.String> priorityFilters)

setStatusFilter

void setStatusFilter(java.util.Collection<java.lang.String> statusFilters)

setComponentFilter

void setComponentFilter(java.util.Collection<java.lang.String> componentFilters)

setAssigneeFiter

void setAssigneeFiter(java.util.Collection<java.lang.String> assigneeFilter)

setJiraFilter

void setJiraFilter(java.util.Collection<java.lang.Long> filterIds)

trash

void trash()


Copyright © 2007-2012 Atlassian. All Rights Reserved.