com.atlassian.greenhopper.service.issuelink
Interface EpicCustomFieldService

All Known Implementing Classes:
EpicCustomFieldServiceImpl

public interface EpicCustomFieldService

Custom field service around all epic functionality-related fields.


Method Summary
 void ensureEpicFieldsHaveCorrectContext()
          It is possible that if the Epic issue type is deleted, it will be re-created and existing contexts set up for Epic-specific custom fields will be invalid.
 void ensureEpicLabelFieldCorrectlyConfigured()
          Ensures that the epic label field is correctly configured.
 void ensureEpicStatusFieldHasCorrectOptionsOrder()
          Ensure that the epic status field has the Options in the correct order.
 com.atlassian.jira.issue.fields.CustomField getDefaultEpicColorField()
           
 com.atlassian.jira.issue.fields.CustomField getDefaultEpicLabelField()
           
 com.atlassian.jira.issue.fields.CustomField getDefaultEpicLinkField()
          Get the Epic Link custom field that GreenHopper is aware of.
 com.atlassian.jira.issue.fields.CustomField getDefaultEpicStatusField()
           
 com.atlassian.fugue.Option<com.atlassian.jira.issue.customfields.option.Option> getDoneEpicStatusOption()
           
 

Method Detail

getDefaultEpicLabelField

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

getDefaultEpicLinkField

com.atlassian.jira.issue.fields.CustomField getDefaultEpicLinkField()
Get the Epic Link custom field that GreenHopper is aware of.

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

getDefaultEpicStatusField

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

getDefaultEpicColorField

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

ensureEpicFieldsHaveCorrectContext

void ensureEpicFieldsHaveCorrectContext()
It is possible that if the Epic issue type is deleted, it will be re-created and existing contexts set up for Epic-specific custom fields will be invalid. We need to be able to re-instate the correct contexts in this scenario.


ensureEpicLabelFieldCorrectlyConfigured

void ensureEpicLabelFieldCorrectlyConfigured()
Ensures that the epic label field is correctly configured.


ensureEpicStatusFieldHasCorrectOptionsOrder

void ensureEpicStatusFieldHasCorrectOptionsOrder()
Ensure that the epic status field has the Options in the correct order.


getDoneEpicStatusOption

com.atlassian.fugue.Option<com.atlassian.jira.issue.customfields.option.Option> getDoneEpicStatusOption()
Returns:
the Option which corresponds to the "Done" choice for Epic Status field (which is a Select custom field). But actually, in some cases there may be no Option. So we return an Option of an Option. "Yo dawg..." etc etc. Note: Options can be "disabled" in the Admin UI. But we do not respect this setting. So the Option returned may not be settable via JIRA's Edit Issue, but it will still succeed when we edit the value from our interface.


Copyright © 2007-2014 Atlassian. All Rights Reserved.