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

static final String CUSTOM_FIELD_PREFIX
See Also:
Constant Field Values
Method Detail

getField

Field getField(String id)
Get a field by its id.

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

isCustomField

boolean isCustomField(String id)

isCustomField

boolean isCustomField(Field field)

getCustomField

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

boolean isHideableField(String id)

isHideableField

boolean isHideableField(Field field)

getHideableField

HideableField getHideableField(String id)

isOrderableField

boolean isOrderableField(String id)

isOrderableField

boolean isOrderableField(Field field)

getOrderableField

OrderableField getOrderableField(String id)

getConfigurableField

ConfigurableField getConfigurableField(String id)

getOrderableFields

Set getOrderableFields()

isNavigableField

boolean isNavigableField(String id)

isNavigableField

boolean isNavigableField(Field field)

getNavigableField

NavigableField getNavigableField(String id)

isRequirableField

boolean isRequirableField(String id)

isRequirableField

boolean isRequirableField(Field field)

isMandatoryField

boolean isMandatoryField(String id)

isMandatoryField

boolean isMandatoryField(Field field)

isRenderableField

boolean isRenderableField(String id)

isRenderableField

boolean isRenderableField(Field field)

isUnscreenableField

boolean isUnscreenableField(String id)

isUnscreenableField

boolean isUnscreenableField(Field field)

getRequiredField

RequirableField getRequiredField(String id)

getCustomFieldManager

CustomFieldManager getCustomFieldManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead


getFieldLayoutManager

FieldLayoutManager getFieldLayoutManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead


getColumnLayoutManager

ColumnLayoutManager getColumnLayoutManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead


refresh

void refresh()

getUnavailableFields

Set getUnavailableFields()

isFieldHidden

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

isFieldHidden

boolean isFieldHidden(User remoteUser,
                      String fieldId)
                      throws FieldLayoutStorageException
Throws:
FieldLayoutStorageException

getAvailableCustomFieldsWithScope

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

getAvailableNavigableFieldsWithScope

Set getAvailableNavigableFieldsWithScope(User user,
                                         List projectIds,
                                         List issueTypes)
                                         throws FieldException
Parameters:
user - the remote user.
projectIds - a List of Longs
issueTypes -
Returns:
Throws:
FieldException

getAvailableCustomFields

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

getAllAvailableNavigableFields

Set getAllAvailableNavigableFields()
                                   throws FieldException
Throws:
FieldException

getAvailableNavigableFields

Set getAvailableNavigableFields(User remoteUser)
                                throws FieldException
Throws:
FieldException

getAllSearchableFields

Set getAllSearchableFields()

getIssueTypeSystemField

IssueTypeSystemField getIssueTypeSystemField()

getProjectSystemField

ProjectSystemField getProjectSystemField()

isTimeTrackingOn

boolean isTimeTrackingOn()


Copyright © 2002-2009 Atlassian. All Rights Reserved.