com.atlassian.greenhopper.service.rank
Interface RankCustomFieldService

All Known Implementing Classes:

RankCustomFieldServiceImpl

public interface RankCustomFieldService

Method Summary

com.atlassian.fugue.Option<com.atlassian.jira.issue.fields.CustomField>	getDefaultRankField() Get the global rank custom field that GreenHopper is aware of.
com.atlassian.jira.issue.fields.CustomField	getOrCreateDefaultRankField() Get the global rank custom field that GreenHopper is aware of.
java.util.List<com.atlassian.jira.issue.fields.CustomField>	getRankFields() Get all Rank custom fields.
ServiceOutcome<SortedByRankFieldResult>	getSortedByRankField(com.atlassian.query.Query query) Get the sorted by rank field
ServiceOutcome<java.lang.Boolean>	isFieldNameInQuerySafe(com.atlassian.jira.issue.fields.CustomField rankField) Can the field name be used inside a query? Using the name could be invalid, in case another field with the given name exists.
boolean	isRankCustomFieldType(com.atlassian.jira.issue.fields.CustomField customField) Is the passed custom field of type "Global Rank".
boolean	isRankField(com.atlassian.jira.issue.fields.CustomField customField) Is the passed custom field of type "Global Rank"
boolean	isRankField(long customFieldId) Is the passed custom field id of type "Global Rank"
ServiceOutcome<java.lang.Void>	validateRankFieldConfiguration(com.atlassian.jira.issue.fields.CustomField customField) Validates the passed rank custom field configuration

Method Detail

getDefaultRankField

com.atlassian.fugue.Option<com.atlassian.jira.issue.fields.CustomField> getDefaultRankField()

Get the global rank custom field that GreenHopper is aware of.

Returns:

the custom field. If the field does not yet exist, it will NOT be created.

getOrCreateDefaultRankField

com.atlassian.jira.issue.fields.CustomField getOrCreateDefaultRankField()

Get the global rank custom field that GreenHopper is aware of.

Returns:

the custom field. If the field does not yet exist, it will be created.

isRankField

boolean isRankField(com.atlassian.jira.issue.fields.CustomField customField)

Is the passed custom field of type "Global Rank"

isRankField

boolean isRankField(long customFieldId)

Is the passed custom field id of type "Global Rank"

isRankCustomFieldType

boolean isRankCustomFieldType(com.atlassian.jira.issue.fields.CustomField customField)

Is the passed custom field of type "Global Rank". Does not perform any further checks on the field

getRankFields

@Nonnull
java.util.List<com.atlassian.jira.issue.fields.CustomField> getRankFields()

Get all Rank custom fields.

Returns:

a list of rank fields.

validateRankFieldConfiguration

ServiceOutcome<java.lang.Void> validateRankFieldConfiguration(com.atlassian.jira.issue.fields.CustomField customField)

Validates the passed rank custom field configuration

getSortedByRankField

ServiceOutcome<SortedByRankFieldResult> getSortedByRankField(com.atlassian.query.Query query)

Get the sorted by rank field

Returns:

A SortedByRankFieldResult in case the query is sorted by a rank field. Result can contain warnings, in which case the returned field is *not* valid for use. An error outcome is returned in case the query is not sorted by a rank field

isFieldNameInQuerySafe

ServiceOutcome<java.lang.Boolean> isFieldNameInQuerySafe(com.atlassian.jira.issue.fields.CustomField rankField)

Can the field name be used inside a query? Using the name could be invalid, in case another field with the given name exists.