|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.greenhopper.model.rapid.StatisticsFieldInstance
public class StatisticsFieldInstance
Represents an instance of a StatisticsFieldConfig
for a RapidView
. This should be used when "resolving"
the configuration of the Statistics Field in a request which requires real knowledge of how that configuration works
at run-time. Specifically, if a StatisticsFieldConfig
has type StatisticsFieldConfig.Type.JIRA_FIELD
,
the configuration will only tell you the ID of the field used, but this object will allow you to resolve the proper
name of that configuration, provided that the field is still around at this point.
StatisticsFieldService
,
StatisticsFieldConfig
Method Summary | |
---|---|
static StatisticsFieldInstance |
forJiraField(StatisticsFieldConfig config,
com.atlassian.jira.issue.fields.Field field)
|
static StatisticsFieldInstance |
forJiraFieldWithName(StatisticsFieldConfig config,
com.atlassian.jira.issue.fields.Field field,
java.lang.String nameKey)
|
static StatisticsFieldInstance |
forJiraFieldWithNameWithDocumentId(StatisticsFieldConfig config,
com.atlassian.jira.issue.fields.Field field,
java.lang.String nameKey,
java.lang.String documentId)
|
static StatisticsFieldInstance |
forNonField(StatisticsFieldConfig config,
java.lang.String nameKey)
|
StatisticsFieldConfig |
getConfig()
Returns the configuration associated with this instance. |
java.lang.String |
getDisplayName(I18n2 i18n)
Get the display name of this instance |
java.lang.String |
getDocumentId()
Note: behaviour is only determined for this method when StatisticsField.isValid() is true. |
com.atlassian.jira.issue.fields.Field |
getField()
Returns the field that the configuration refers to, if it is still available at this time. |
java.lang.String |
getName(I18n2 i18n)
|
boolean |
isEnabled()
Note: this method cannot return true if StatisticsField.isValid() is false. |
boolean |
isFieldBased()
|
boolean |
isValid()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static StatisticsFieldInstance forNonField(StatisticsFieldConfig config, java.lang.String nameKey)
public static StatisticsFieldInstance forJiraField(StatisticsFieldConfig config, com.atlassian.jira.issue.fields.Field field)
public static StatisticsFieldInstance forJiraFieldWithName(StatisticsFieldConfig config, com.atlassian.jira.issue.fields.Field field, java.lang.String nameKey)
public static StatisticsFieldInstance forJiraFieldWithNameWithDocumentId(StatisticsFieldConfig config, com.atlassian.jira.issue.fields.Field field, java.lang.String nameKey, java.lang.String documentId)
public StatisticsFieldConfig getConfig()
StatisticsField
getConfig
in interface StatisticsField
public java.lang.String getDisplayName(I18n2 i18n)
StatisticsField
getDisplayName
in interface StatisticsField
i18n
- the i18n bean
public boolean isFieldBased()
isFieldBased
in interface StatisticsField
public java.lang.String getName(I18n2 i18n)
public com.atlassian.jira.issue.fields.Field getField()
StatisticsField
getField
in interface StatisticsField
public boolean isValid()
isValid
in interface StatisticsField
public boolean isEnabled()
StatisticsField
StatisticsField.isValid()
is false.
isEnabled
in interface StatisticsField
public java.lang.String getDocumentId()
StatisticsField
StatisticsField.isValid()
is true.
getDocumentId
in interface StatisticsField
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |