|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher com.atlassian.jira.issue.search.searchers.impl.WorkRatioSearcher
public class WorkRatioSearcher
Field Summary | |
---|---|
protected ApplicationProperties |
applicationProperties
|
protected FieldVisibilityBean |
fieldVisibilityBean
|
static String |
MAX_FIELD
|
static String |
MAX_LIMIT_SUFFIX
|
static String |
MIN_FIELD
|
static String |
MIN_LIMIT_SUFFIX
|
static String |
WORK_RATIO_ID
|
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 | |
---|---|
WorkRatioSearcher(JiraAuthenticationContext authenticationContext,
FieldVisibilityBean fieldVisibilityBean,
ApplicationProperties applicationProperties)
|
Method Summary | |
---|---|
String |
getId()
The unique id of the field |
String |
getMaxField()
|
String |
getMinField()
|
String |
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed |
String |
getQuerySnippet(SearchRequest searchRequest)
Returns a JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter
in the searchRequest. |
List |
getRelatedIndexers()
Returns a list of FieldIndexer objects. |
boolean |
isRevelentForSeachRequest(SearchRequest searchRequest)
Checks if the searchRequest object has SearchParameter objects that was created by the searcher |
boolean |
isShown(SearchContext searchContext)
Checks if the searcher should be shown in this context |
void |
populateFromParams(FieldValuesHolder fieldValuesHolder,
ActionParams actionParams)
Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams |
void |
populateFromSearchRequest(FieldValuesHolder fieldValuesHolder,
SearchRequest searchRequest)
Populate FieldValuesHolder from the SearchRequest object. |
void |
populateSearchRequest(SearchRequest searchRequest,
FieldValuesHolder fieldValuesHolder)
Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder |
void |
validateParams(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
I18nHelper i18nHelper,
ErrorCollection errors)
Adds error meessages to the errors object if values in the fieldValuesHolder fails validation. |
Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher |
---|
compareTo, equals, getEditHtml, getI18n, getName, getVelocityParams, getViewHtml, hashCode, hasPermission, init, register, renderEditTemplate, renderViewTemplate, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String MIN_LIMIT_SUFFIX
public static final String MAX_LIMIT_SUFFIX
public static final String WORK_RATIO_ID
public static final String MAX_FIELD
public static final String MIN_FIELD
protected final FieldVisibilityBean fieldVisibilityBean
protected final ApplicationProperties applicationProperties
Constructor Detail |
---|
public WorkRatioSearcher(JiraAuthenticationContext authenticationContext, FieldVisibilityBean fieldVisibilityBean, ApplicationProperties applicationProperties)
Method Detail |
---|
public List getRelatedIndexers()
IssueSearcher
FieldIndexer
objects. The objects should be initialised and ready for action
List
of FieldIndexer
objects. Must not be null. Return Collections.EMPTY_LIST
if not availablepublic void validateParams(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
IssueSearcher
searchContext
- the context of the search (i.e. projects and issue types selected)fieldValuesHolder
- contains values populated by the searcherspublic void populateFromParams(FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
IssueSearcher
FieldValuesHolder
object with whatever values the searcher is interested in from the ActionParams
fieldValuesHolder
- contains values populated by the searchersactionParams
- params from the webwork front endpublic void populateFromSearchRequest(FieldValuesHolder fieldValuesHolder, SearchRequest searchRequest)
IssueSearcher
FieldValuesHolder
from the SearchRequest
object. Which SearchParameter
really
to take from the SR should match with the method IssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)
fieldValuesHolder
- contains values populated by the searcherssearchRequest
- relevent search requestIssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)
public void populateSearchRequest(SearchRequest searchRequest, FieldValuesHolder fieldValuesHolder)
IssueSearcher
SearchRequest
with SearchParameter
objects from the FieldValuesHolder
searchRequest
- relevent search requestfieldValuesHolder
- contains values populated by the searcherspublic boolean isRevelentForSeachRequest(SearchRequest searchRequest)
IssueSearcher
SearchParameter
objects that was created by the searcher
searchRequest
- relevent search request
public String getId()
Field
public String getNameKey()
Field
public boolean isShown(SearchContext searchContext)
IssueSearcher
isShown
in interface IssueSearcher
isShown
in class AbstractIssueSearcher
searchContext
- the context of the search (i.e. projects and issue types selected)
public String getQuerySnippet(SearchRequest searchRequest)
IssueSearcher
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequest. The queryString should be able to be converted back to the original SearchRequest. i.e.
getQuerySnippet -> String -> populateFromParams -> FieldValuesHolder -> populateSearchRequest -> SearchRequest ->
getQuerySnippet should return the same original string.
searchRequest
- relevent search request
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequestpublic String getMaxField()
public String getMinField()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |