com.atlassian.jira.issue.fields
Class DefaultFieldManager

java.lang.Object
  extended by com.atlassian.jira.issue.fields.DefaultFieldManager
All Implemented Interfaces:
FieldManager

public class DefaultFieldManager
extends Object
implements FieldManager


Field Summary
 
Fields inherited from interface com.atlassian.jira.issue.fields.FieldManager
CUSTOM_FIELD_PREFIX
 
Constructor Summary
DefaultFieldManager()
           
 
Method Summary
 Set getAllAvailableNavigableFields()
          Returns a set of Fields that are NOT hidden in AT LEAST ONE project in the system.
 Set getAllSearchableFields()
           
 Set getAvailableCustomFields(User remoteUser, org.ofbiz.core.entity.GenericValue issue)
          Retrieves custom fields in scope for the given issue
 Set getAvailableCustomFieldsWithScope(User remoteUser, List projectIds, List issueTypes)
          Returns a set of CustomFields that are in scope
 Set getAvailableNavigableFields(User remoteUser)
          Returns a set of Fields that are NOT hidden in AT LEAST ONE project that the remote user can see (has Permissions.BROWSE permission for).
 Set getAvailableNavigableFieldsWithScope(User remoteUser, List projectIds, List issueTypes)
          Returns a set of Fields that are NOT hidden in AT LEAST ONE project that the remote user can see (has Permissions.BROWSE permission for).
 ColumnLayoutManager getColumnLayoutManager()
          Deprecated. Declare your dependency and let PicoContainer resolve it instead
 ConfigurableField getConfigurableField(String id)
           
 CustomField getCustomField(String key)
          Get a CustomField by its text key (eg 'customfield_10000').
 CustomFieldManager getCustomFieldManager()
           
 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 key)
           
protected  boolean isEnterpriseEdition()
           
 boolean isFieldHidden(User remoteUser, Field field)
          Determines whether the field is NOT hidden in AT LEAST one FieldLayout that the user can see (assigned to projects for which the user has the Permissions.BROWSE permission).
 boolean isFieldHidden(User remoteUser, String fieldId)
          Determines whether the field with id of fieldId is NOT hidden in AT LEAST one FieldLayout that the user can see (assigned to projects for which the user has the Permissions.BROWSE permission).
 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)
           
protected  boolean isSubTasksOn()
           
 boolean isTimeTrackingOn()
           
 boolean isUnscreenableField(Field field)
           
 boolean isUnscreenableField(String id)
           
protected  boolean isVotingOn()
           
 void refresh()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultFieldManager

public DefaultFieldManager()
Method Detail

getField

public Field getField(String id)
Description copied from interface: FieldManager
Get a field by its id.

Specified by:
getField in interface FieldManager
Parameters:
id - An IssueFieldConstants constant, or custom field key (eg. "customfield_10010")

getAllAvailableNavigableFields

public Set getAllAvailableNavigableFields()
                                   throws FieldException
Returns a set of Fields that are NOT hidden in AT LEAST ONE project in the system.

NOTE: This method is used in the Admin interface, as admins should be able to configure the default ColumnLayouts irrespective of their permissions. They should be able to see all fields that are not hidden in at least one FieldLayout in the system

Specified by:
getAllAvailableNavigableFields in interface FieldManager
Throws:
FieldException - if cannot retrieve the projects the user can see, or if cannot retrieve the field layouts for the viewable projects

getAvailableNavigableFields

public Set getAvailableNavigableFields(User remoteUser)
                                throws FieldException
Returns a set of Fields that are NOT hidden in AT LEAST ONE project that the remote user can see (has Permissions.BROWSE permission for).

The returned set of fields contains all custom fields that are not hidden in AT LEAST one FieldLayout that the user can see.

NOTE: This method is primarily used for configuring user's ColumnLayout, as the user should be able to add any field (including custom field) to it that they can see in the system. THe scope of custom fields is ignored here as the user configures the ColumnLayout outside of scope.

Specified by:
getAvailableNavigableFields in interface FieldManager
Parameters:
remoteUser -
Throws:
FieldException - if cannot retrieve the projects the user can see, or if cannot retrieve the field layouts for the viewable projects

getAllSearchableFields

public Set getAllSearchableFields()
Specified by:
getAllSearchableFields in interface FieldManager

getIssueTypeSystemField

public IssueTypeSystemField getIssueTypeSystemField()
Specified by:
getIssueTypeSystemField in interface FieldManager

getProjectSystemField

public ProjectSystemField getProjectSystemField()
Specified by:
getProjectSystemField in interface FieldManager

getAvailableNavigableFieldsWithScope

public Set getAvailableNavigableFieldsWithScope(User remoteUser,
                                                List projectIds,
                                                List issueTypes)
                                         throws FieldException
Returns a set of Fields that are NOT hidden in AT LEAST ONE project that the remote user can see (has Permissions.BROWSE permission for).

NOTE: This method is used when actually showing the results (e.g. in Issue Navigator) to determine if the field (column) should be actually shown.

Specified by:
getAvailableNavigableFieldsWithScope in interface FieldManager
Parameters:
remoteUser - the remote user.
projectIds - a List of Longs.
Returns:
Throws:
FieldException - if cannot retrieve the projects the user can see, or if cannot retrieve the field layouts for the viewable projects

getAvailableCustomFields

public Set getAvailableCustomFields(User remoteUser,
                                    org.ofbiz.core.entity.GenericValue issue)
                             throws FieldException
Retrieves custom fields in scope for the given issue

Specified by:
getAvailableCustomFields in interface FieldManager
Parameters:
remoteUser -
issue -
Throws:
FieldException

getAvailableCustomFieldsWithScope

public Set getAvailableCustomFieldsWithScope(User remoteUser,
                                             List projectIds,
                                             List issueTypes)
                                      throws FieldException
Returns a set of CustomFields that are in scope

Specified by:
getAvailableCustomFieldsWithScope in interface FieldManager
Parameters:
remoteUser -
Throws:
FieldException - if cannot retrieve the projects the user can see, or if cannot retrieve the field layouts for the viewable projects

isFieldHidden

public boolean isFieldHidden(User remoteUser,
                             String fieldId)
                      throws FieldLayoutStorageException
Determines whether the field with id of fieldId is NOT hidden in AT LEAST one FieldLayout that the user can see (assigned to projects for which the user has the Permissions.BROWSE permission).

Specified by:
isFieldHidden in interface FieldManager
Parameters:
remoteUser - the remote user.
fieldId -
Throws:
FieldLayoutStorageException

isFieldHidden

public boolean isFieldHidden(User remoteUser,
                             Field field)
                      throws FieldLayoutStorageException
Determines whether the field is NOT hidden in AT LEAST one FieldLayout that the user can see (assigned to projects for which the user has the Permissions.BROWSE permission).

Specified by:
isFieldHidden in interface FieldManager
Parameters:
remoteUser - the remote user.
field -
Throws:
FieldLayoutStorageException

isCustomField

public boolean isCustomField(String key)
Specified by:
isCustomField in interface FieldManager

isCustomField

public boolean isCustomField(Field field)
Specified by:
isCustomField in interface FieldManager

getCustomField

public CustomField getCustomField(String key)
Description copied from interface: FieldManager
Get a CustomField by its text key (eg 'customfield_10000').

Specified by:
getCustomField in interface FieldManager
Parameters:
key - Eg. 'customfield_10000'
Returns:
The CustomField or null if not found.

isHideableField

public boolean isHideableField(String id)
Specified by:
isHideableField in interface FieldManager

isHideableField

public boolean isHideableField(Field field)
Specified by:
isHideableField in interface FieldManager

getHideableField

public HideableField getHideableField(String id)
Specified by:
getHideableField in interface FieldManager

isOrderableField

public boolean isOrderableField(String id)
Specified by:
isOrderableField in interface FieldManager

isOrderableField

public boolean isOrderableField(Field field)
Specified by:
isOrderableField in interface FieldManager

getOrderableField

public OrderableField getOrderableField(String id)
Specified by:
getOrderableField in interface FieldManager

getConfigurableField

public ConfigurableField getConfigurableField(String id)
Specified by:
getConfigurableField in interface FieldManager

getOrderableFields

public Set getOrderableFields()
Specified by:
getOrderableFields in interface FieldManager

isNavigableField

public boolean isNavigableField(String id)
Specified by:
isNavigableField in interface FieldManager

isNavigableField

public boolean isNavigableField(Field field)
Specified by:
isNavigableField in interface FieldManager

getNavigableField

public NavigableField getNavigableField(String id)
Specified by:
getNavigableField in interface FieldManager

isRequirableField

public boolean isRequirableField(String id)
Specified by:
isRequirableField in interface FieldManager

isRequirableField

public boolean isRequirableField(Field field)
Specified by:
isRequirableField in interface FieldManager

isMandatoryField

public boolean isMandatoryField(String id)
Specified by:
isMandatoryField in interface FieldManager

isMandatoryField

public boolean isMandatoryField(Field field)
Specified by:
isMandatoryField in interface FieldManager

isRenderableField

public boolean isRenderableField(String id)
Specified by:
isRenderableField in interface FieldManager

isRenderableField

public boolean isRenderableField(Field field)
Specified by:
isRenderableField in interface FieldManager

isUnscreenableField

public boolean isUnscreenableField(String id)
Specified by:
isUnscreenableField in interface FieldManager

isUnscreenableField

public boolean isUnscreenableField(Field field)
Specified by:
isUnscreenableField in interface FieldManager

getRequiredField

public RequirableField getRequiredField(String id)
Specified by:
getRequiredField in interface FieldManager

getCustomFieldManager

public CustomFieldManager getCustomFieldManager()
Specified by:
getCustomFieldManager in interface FieldManager

getFieldLayoutManager

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

Specified by:
getFieldLayoutManager in interface FieldManager

getColumnLayoutManager

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

Specified by:
getColumnLayoutManager in interface FieldManager

refresh

public void refresh()
Specified by:
refresh in interface FieldManager

isTimeTrackingOn

public boolean isTimeTrackingOn()
Specified by:
isTimeTrackingOn in interface FieldManager

isVotingOn

protected boolean isVotingOn()

isEnterpriseEdition

protected boolean isEnterpriseEdition()

isSubTasksOn

protected boolean isSubTasksOn()

getUnavailableFields

public Set getUnavailableFields()
Specified by:
getUnavailableFields in interface FieldManager


Copyright © 2002-2009 Atlassian. All Rights Reserved.