com.atlassian.greenhopper.service.rank
Class RankCustomFieldServiceImpl

java.lang.Object
  com.atlassian.greenhopper.service.rank.RankCustomFieldServiceImpl

All Implemented Interfaces:

RankCustomFieldService

@Service
public class RankCustomFieldServiceImpl
extends java.lang.Object
implements RankCustomFieldService

Field Summary

protected LoggerWrapper

log

Constructor Summary

RankCustomFieldServiceImpl()

Method Summary

void	addChangeItem(com.atlassian.crowd.embedded.api.User user, RankChange rankChange) Adds a change item to the issues change history
com.atlassian.jira.issue.fields.CustomField	getDefaultRankField() Get the global rank custom field that GreenHopper is aware of.
java.util.List<com.atlassian.jira.issue.fields.CustomField>	getRankFields()
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.crowd.embedded.api.User user, com.atlassian.jira.issue.fields.CustomField customField) Validates the passed rank custom field configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final LoggerWrapper log

Constructor Detail

RankCustomFieldServiceImpl

public RankCustomFieldServiceImpl()

Method Detail

getDefaultRankField

public com.atlassian.jira.issue.fields.CustomField getDefaultRankField()

Description copied from interface: RankCustomFieldService

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

Specified by:

getDefaultRankField in interface RankCustomFieldService

Returns:

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

addChangeItem

public void addChangeItem(com.atlassian.crowd.embedded.api.User user,
                          RankChange rankChange)

Adds a change item to the issues change history

Specified by:

addChangeItem in interface RankCustomFieldService

isRankField

public boolean isRankField(long customFieldId)

Description copied from interface: RankCustomFieldService

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

Specified by:

isRankField in interface RankCustomFieldService

isRankField

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

Description copied from interface: RankCustomFieldService

Is the passed custom field of type "Global Rank"

Specified by:

isRankField in interface RankCustomFieldService

isRankCustomFieldType

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

Description copied from interface: RankCustomFieldService

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

Specified by:

isRankCustomFieldType in interface RankCustomFieldService

validateRankFieldConfiguration

public ServiceOutcome<java.lang.Void> validateRankFieldConfiguration(com.atlassian.crowd.embedded.api.User user,
                                                                     com.atlassian.jira.issue.fields.CustomField customField)

Description copied from interface: RankCustomFieldService

Validates the passed rank custom field configuration

Specified by:

validateRankFieldConfiguration in interface RankCustomFieldService

getSortedByRankField

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

Description copied from interface: RankCustomFieldService

Get the sorted by rank field

Specified by:

getSortedByRankField in interface RankCustomFieldService

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

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

Description copied from interface: RankCustomFieldService

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

Specified by:

isFieldNameInQuerySafe in interface RankCustomFieldService

getRankFields

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

Specified by:

getRankFields in interface RankCustomFieldService