com.atlassian.jira.issue.fields
Interface FieldManager

All Known Implementing Classes:

DefaultFieldManager

public interface FieldManager

Field Summary

static String

CUSTOM_FIELD_PREFIX

Method Summary

Set	getAllAvailableNavigableFields()
Set	getAllSearchableFields()
Set	getAvailableCustomFields(User remoteUser, org.ofbiz.core.entity.GenericValue issue)
Set	getAvailableCustomFieldsWithScope(User remoteUser, List projectIds, List issueTypes)
Set	getAvailableNavigableFields(User remoteUser)
Set	getAvailableNavigableFieldsWithScope(User user, List projectIds, List issueTypes)
ColumnLayoutManager	getColumnLayoutManager() Deprecated. Declare your dependency and let PicoContainer resolve it instead
ConfigurableField	getConfigurableField(String id)
CustomField	getCustomField(String id) Get a CustomField by its text key (eg 'customfield_10000').
CustomFieldManager	getCustomFieldManager() Deprecated. Declare your dependency and let PicoContainer resolve it instead
Field	getField(String id) Get a field by its id.
FieldLayoutManager	getFieldLayoutManager() Deprecated. Declare your dependency and let PicoContainer resolve it instead
HideableField	getHideableField(String id)
IssueTypeSystemField	getIssueTypeSystemField()
NavigableField	getNavigableField(String id)
OrderableField	getOrderableField(String id)
Set	getOrderableFields()
ProjectSystemField	getProjectSystemField()
RequirableField	getRequiredField(String id)
Set	getUnavailableFields()
boolean	isCustomField(Field field)
boolean	isCustomField(String id)
boolean	isFieldHidden(User remoteUser, Field field)
boolean	isFieldHidden(User remoteUser, String fieldId)
boolean	isHideableField(Field field)
boolean	isHideableField(String id)
boolean	isMandatoryField(Field field)
boolean	isMandatoryField(String id)
boolean	isNavigableField(Field field)
boolean	isNavigableField(String id)
boolean	isOrderableField(Field field)
boolean	isOrderableField(String id)
boolean	isRenderableField(Field field)
boolean	isRenderableField(String id)
boolean	isRequirableField(Field field)
boolean	isRequirableField(String id)
boolean	isTimeTrackingOn()
boolean	isUnscreenableField(Field field)
boolean	isUnscreenableField(String id)
void	refresh()

Field Detail

CUSTOM_FIELD_PREFIX

public static final String CUSTOM_FIELD_PREFIX

See Also:

Constant Field Values

Method Detail

getField

public Field getField(String id)

Get a field by its id.

Parameters:

id - An IssueFieldConstants constant, or custom field key (eg. "customfield_10010")

isCustomField

public boolean isCustomField(String id)

isCustomField

public boolean isCustomField(Field field)

getCustomField

public CustomField getCustomField(String id)

Get a CustomField by its text key (eg 'customfield_10000').

Parameters:

id - Eg. 'customfield_10000'

Returns:

The CustomField or null if not found.

isHideableField

public boolean isHideableField(String id)

isHideableField

public boolean isHideableField(Field field)

getHideableField

public HideableField getHideableField(String id)

isOrderableField

public boolean isOrderableField(String id)

isOrderableField

public boolean isOrderableField(Field field)

getOrderableField

public OrderableField getOrderableField(String id)

getConfigurableField

public ConfigurableField getConfigurableField(String id)

getOrderableFields

public Set getOrderableFields()

isNavigableField

public boolean isNavigableField(String id)

isNavigableField

public boolean isNavigableField(Field field)

getNavigableField

public NavigableField getNavigableField(String id)

isRequirableField

public boolean isRequirableField(String id)

isRequirableField

public boolean isRequirableField(Field field)

isMandatoryField

public boolean isMandatoryField(String id)

isMandatoryField

public boolean isMandatoryField(Field field)

isRenderableField

public boolean isRenderableField(String id)

isRenderableField

public boolean isRenderableField(Field field)

isUnscreenableField

public boolean isUnscreenableField(String id)

isUnscreenableField

public boolean isUnscreenableField(Field field)

getRequiredField

public RequirableField getRequiredField(String id)

getCustomFieldManager

public CustomFieldManager getCustomFieldManager()

Deprecated. Declare your dependency and let PicoContainer resolve it instead

getFieldLayoutManager

public FieldLayoutManager getFieldLayoutManager()

Deprecated. Declare your dependency and let PicoContainer resolve it instead

getColumnLayoutManager

public ColumnLayoutManager getColumnLayoutManager()

Deprecated. Declare your dependency and let PicoContainer resolve it instead

refresh

public void refresh()

getUnavailableFields

public Set getUnavailableFields()

isFieldHidden

public boolean isFieldHidden(User remoteUser,
                             Field field)
                      throws FieldLayoutStorageException,
                             org.ofbiz.core.entity.GenericEntityException

Throws:

FieldLayoutStorageException

org.ofbiz.core.entity.GenericEntityException

isFieldHidden

public boolean isFieldHidden(User remoteUser,
                             String fieldId)
                      throws FieldLayoutStorageException

Throws:

FieldLayoutStorageException

getAvailableCustomFieldsWithScope

public Set getAvailableCustomFieldsWithScope(User remoteUser,
                                             List projectIds,
                                             List issueTypes)
                                      throws FieldException

Throws:

FieldException

getAvailableNavigableFieldsWithScope

public Set getAvailableNavigableFieldsWithScope(User user,
                                                List projectIds,
                                                List issueTypes)
                                         throws FieldException

Throws:

FieldException

getAvailableCustomFields

public Set getAvailableCustomFields(User remoteUser,
                                    org.ofbiz.core.entity.GenericValue issue)
                             throws FieldException

Throws:

FieldException

getAllAvailableNavigableFields

public Set getAllAvailableNavigableFields()
                                   throws FieldException

Throws:

FieldException

getAvailableNavigableFields

public Set getAvailableNavigableFields(User remoteUser)
                                throws FieldException

Throws:

FieldException

getAllSearchableFields

public Set getAllSearchableFields()

getIssueTypeSystemField

public IssueTypeSystemField getIssueTypeSystemField()

getProjectSystemField

public ProjectSystemField getProjectSystemField()

isTimeTrackingOn

public boolean isTimeTrackingOn()