com.atlassian.jira.issue.search.searchers.impl
Class AssigneeSearcher

java.lang.Object
  extended by com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher
      extended by com.atlassian.jira.issue.search.searchers.impl.AbstractUserSearcher
          extended by com.atlassian.jira.issue.search.searchers.impl.AssigneeSearcher
All Implemented Interfaces:
Field, IssueSearcher, Comparable

public class AssigneeSearcher
extends AbstractUserSearcher


Field Summary
static String ASSIGNEE_FIELD
          field input form element name
static String ASSIGNEE_SELECT_LIST
          select box input form element name
protected  FieldVisibilityBean fieldVisibilityBean
           
static String NAME_KEY
          message resource key
 
Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractUserSearcher
applicationProperties, searchService, SELECT_LIST_GROUP, SELECT_LIST_NONE, SELECT_LIST_USER
 
Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher
authenticationContext, EDIT_TEMPLATE_SUFFIX, field, VIEW_TEMPLATE_SUFFIX
 
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
I18N_BUNDLE, log
 
Constructor Summary
AssigneeSearcher(JiraAuthenticationContext authenticationContext, FieldVisibilityBean fieldVisibilityBean, ApplicationProperties applicationProperties, UserPickerSearchService searchService)
          Constructs a new instance of this class
 
Method Summary
 String getId()
          Returns ASSIGNEE_FIELD
 String getNameKey()
          Returns NAME_KEY
protected  String getNoneValue()
          Returns DocumentConstants.ISSUE_UNASSIGNED
 List getRelatedIndexers()
          Returns a single element list with an instance of AssigneeIndexer class
 List getSelectListOptions()
          Returns the list of select box options by calling ParameterStore.getAssigneeTypes() on the parameter store for the user retrieved from authentication context.
 String getUserField()
          Returns ASSIGNEE_FIELD
protected  String getUserGroupSearchParamName()
          Returns DocumentConstants.ISSUE_ASSIGNEE_GROUP
protected  String getUserSearchParamName()
          Returns DocumentConstants.ISSUE_ASSIGNEE
 String getUserSelect()
          Returns ASSIGNEE_SELECT_LIST
 boolean isShown(SearchContext searchContext)
          Returns true or false based on fieldVisibilityBean value.
 
Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractUserSearcher
getEditHtml, getI18nBean, getLinkedGroup, getLinkedUser, getQuerySnippet, getTextForuser, getVelocityParams, getViewHtml, isRevelentForSeachRequest, populateFromParams, populateFromSearchRequest, populateSearchRequest, validateParams
 
Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher
compareTo, equals, getI18n, getName, hashCode, hasPermission, init, register, renderEditTemplate, renderViewTemplate, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME_KEY

public static final String NAME_KEY
message resource key

See Also:
Constant Field Values

ASSIGNEE_FIELD

public static final String ASSIGNEE_FIELD
field input form element name

See Also:
Constant Field Values

ASSIGNEE_SELECT_LIST

public static final String ASSIGNEE_SELECT_LIST
select box input form element name

See Also:
Constant Field Values

fieldVisibilityBean

protected final FieldVisibilityBean fieldVisibilityBean
Constructor Detail

AssigneeSearcher

public AssigneeSearcher(JiraAuthenticationContext authenticationContext,
                        FieldVisibilityBean fieldVisibilityBean,
                        ApplicationProperties applicationProperties,
                        UserPickerSearchService searchService)
Constructs a new instance of this class

Parameters:
authenticationContext - authentication context
fieldVisibilityBean - field visibility bean
Method Detail

getId

public String getId()
Returns ASSIGNEE_FIELD

Returns:
ASSIGNEE_FIELD string

getNameKey

public String getNameKey()
Returns NAME_KEY

Returns:
NAME_KEY string

getRelatedIndexers

public List getRelatedIndexers()
Returns a single element list with an instance of AssigneeIndexer class

Returns:
a single element list with an instance of AssigneeIndexer class

isShown

public boolean isShown(SearchContext searchContext)
Returns true or false based on fieldVisibilityBean value. Returns false if field is hidden in all schemes, true otherwise.

Specified by:
isShown in interface IssueSearcher
Overrides:
isShown in class AbstractIssueSearcher
Parameters:
searchContext - search context
Returns:
false if hidden in all schemes, true otherwise

getSelectListOptions

public List getSelectListOptions()
Returns the list of select box options by calling ParameterStore.getAssigneeTypes() on the parameter store for the user retrieved from authentication context.

Specified by:
getSelectListOptions in class AbstractUserSearcher
Returns:
list of select box options

getUserField

public String getUserField()
Returns ASSIGNEE_FIELD

Specified by:
getUserField in class AbstractUserSearcher
Returns:
ASSIGNEE_FIELD string

getUserSelect

public String getUserSelect()
Returns ASSIGNEE_SELECT_LIST

Specified by:
getUserSelect in class AbstractUserSearcher
Returns:
ASSIGNEE_SELECT_LIST string

getNoneValue

protected String getNoneValue()
Returns DocumentConstants.ISSUE_UNASSIGNED

Specified by:
getNoneValue in class AbstractUserSearcher
Returns:
DocumentConstants.ISSUE_UNASSIGNED string

getUserGroupSearchParamName

protected String getUserGroupSearchParamName()
Returns DocumentConstants.ISSUE_ASSIGNEE_GROUP

Specified by:
getUserGroupSearchParamName in class AbstractUserSearcher
Returns:
DocumentConstants.ISSUE_ASSIGNEE_GROUP string

getUserSearchParamName

protected String getUserSearchParamName()
Returns DocumentConstants.ISSUE_ASSIGNEE

Specified by:
getUserSearchParamName in class AbstractUserSearcher
Returns:
DocumentConstants.ISSUE_ASSIGNEE string


Copyright © 2002-2009 Atlassian. All Rights Reserved.