com.atlassian.jira.issue.search
Interface SearchContext

All Known Implementing Classes:
SearchContextImpl

public interface SearchContext


Method Summary
 List getAsIssueContexts()
          Gets the search context as a list of IssueContext objects
 List getIssueTypeIds()
          Issue ids as Strings
 org.ofbiz.core.entity.GenericValue getOnlyProject()
           
 List getProjectCategoryIds()
          Returns selected categories
 List getProjectIds()
          Project ids as Longs.
 boolean isForAnyIssueTypes()
          Returns true if no specific issue types have been selected
 boolean isForAnyProjects()
          Returns whether thr context is global or not.
 boolean isSingleProjectContext()
           
 void verify()
          Verifies that all issue types and projects in the context actually still exists.
 

Method Detail

isForAnyProjects

public boolean isForAnyProjects()
Returns whether thr context is global or not. A context is global when there are no projects & no project categories

Returns:
boolean

isForAnyIssueTypes

public boolean isForAnyIssueTypes()
Returns true if no specific issue types have been selected

Returns:
boolean

isSingleProjectContext

public boolean isSingleProjectContext()

getProjectCategoryIds

public List getProjectCategoryIds()
Returns selected categories

Returns:
Empty list if no categories were selected

getProjectIds

public List getProjectIds()
Project ids as Longs.

Returns:
List of Long objects. Collections.EMPTY_LIST is no project ids

getOnlyProject

public org.ofbiz.core.entity.GenericValue getOnlyProject()

getIssueTypeIds

public List getIssueTypeIds()
Issue ids as Strings

Returns:
List of issue type ids. Collections.EMPTY_LIST is no issue types

getAsIssueContexts

public List getAsIssueContexts()
Gets the search context as a list of IssueContext objects

Returns:
List of IssueContext. If no issue types or projects selected. A blank issue context is returned. Never null.

verify

public void verify()
Verifies that all issue types and projects in the context actually still exists. This might not be the case



Copyright © 2002-2006 Atlassian. All Rights Reserved.