com.atlassian.jira.issue.fields

Class DefaultFieldManager

java.lang.Object

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

Constructors

Constructor and Description
DefaultFieldManager(RequestCacheFactory requestCacheFactory)

Method Summary

Modifier and Type	Method and Description
Set<NavigableField>	getAllAvailableNavigableFields() Returns a set of Fields that are NOT hidden in AT LEAST ONE project in the system.
Set<SearchableField>	getAllSearchableFields() Return all the searchable fields in the system.
Set<CustomField>	getAvailableCustomFields(ApplicationUser remoteUser, Issue issue) Retrieves custom fields in scope for the given issue
Set<NavigableField>	getAvailableNavigableFields(ApplicationUser 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<NavigableField>	getAvailableNavigableFieldsWithScope(ApplicationUser user) Gets all the available fields that the user can see, this is providing no context scope.
Set<NavigableField>	getAvailableNavigableFieldsWithScope(ApplicationUser remoteUser, QueryContext queryContext) Gets all the available fields within the defined scope of the QueryContext.
ConfigurableField	getConfigurableField(String id)
CustomField	getCustomField(String key) Get a CustomField by its text key (eg 'customfield_10000').
Field	getField(String id) Get a field by its id.
HideableField	getHideableField(String id)
IssueTypeField	getIssueTypeField() Retrieve the IssueType system Field.
NavigableField	getNavigableField(String id)
Set<NavigableField>	getNavigableFields()
OrderableField	getOrderableField(String id)
Set<OrderableField>	getOrderableFields()
ProjectField	getProjectField() Retrieve the Project system Field.
RequirableField	getRequiredField(String id)
Set<SearchableField>	getSystemSearchableFields() Return all the searchable systems fields.
Set<Field>	getUnavailableFields()
Set<FieldLayout>	getVisibleFieldLayouts(ApplicationUser user) Returns all the visible FieldLayouts for the given user.
boolean	isCustomField(Field field)
boolean	isCustomField(String key) Returns true if the given ID is a Custom Field that actually exists in JIRA.
boolean	isCustomFieldId(String id) Returns true if the given field ID is in the custom field format.
boolean	isExistingCustomField(String id) Returns true if the given ID is a Custom Field that actually exists in JIRA.
boolean	isFieldHidden(ApplicationUser remoteUser, Field field)
boolean	isFieldHidden(ApplicationUser 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 ProjectPermissions.BROWSE_PROJECTS permission).
boolean	isFieldHidden(Set<FieldLayout> fieldLayouts, Field field) Checks whether the given field is hidden in all of the given Field Layouts.
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() Invalidates all field-related caches in JIRA.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFieldManager

public DefaultFieldManager(RequestCacheFactory requestCacheFactory)

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")

Returns:

the Field

getAllAvailableNavigableFields

public Set<NavigableField> 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<NavigableField> getAvailableNavigableFields(ApplicationUser 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 - the remote user

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<SearchableField> getAllSearchableFields()

Description copied from interface: FieldManager

Return all the searchable fields in the system. This set will included all defined custom fields.

Specified by:

getAllSearchableFields in interface FieldManager

Returns:

the set of all searchable fields in the system.

getSystemSearchableFields

public Set<SearchableField> getSystemSearchableFields()

Description copied from interface: FieldManager

Return all the searchable systems fields. This set will *NOT* include defined custom fields.

Specified by:

getSystemSearchableFields in interface FieldManager

Returns:

the set of all searchable systems fields defined.

getIssueTypeField

public IssueTypeField getIssueTypeField()

Description copied from interface: FieldManager

Retrieve the IssueType system Field.

Specified by:

getIssueTypeField in interface FieldManager

Returns:

the IssueType system Field.

getProjectField

public ProjectField getProjectField()

Description copied from interface: FieldManager

Retrieve the Project system Field.

Specified by:

getProjectField in interface FieldManager

Returns:

the Project system Field.

getAvailableNavigableFieldsWithScope

public Set<NavigableField> getAvailableNavigableFieldsWithScope(ApplicationUser user)
                                                         throws FieldException

Description copied from interface: FieldManager

Gets all the available fields that the user can see, this is providing no context scope.

Specified by:

getAvailableNavigableFieldsWithScope in interface FieldManager

Parameters:

user - the remote user.

Returns:

a set of NavigableFields that can be show because their visibility/configuration fall within what the user can see.

Throws:

FieldException - thrown if there is a problem looking up the fields

getAvailableNavigableFieldsWithScope

public Set<NavigableField> getAvailableNavigableFieldsWithScope(ApplicationUser remoteUser,
                                                                QueryContext queryContext)
                                                         throws FieldException

Description copied from interface: FieldManager

Gets all the available fields within the defined scope of the QueryContext.

Specified by:

getAvailableNavigableFieldsWithScope in interface FieldManager

Parameters:

remoteUser - the user making the request

queryContext - the context of the search request.

Returns:

a set of NavigableFields that can be show because their visibility/configuration fall within the specified context

Throws:

FieldException - thrown if there is a problem looking up the fields

getAvailableCustomFields

public Set<CustomField> getAvailableCustomFields(ApplicationUser remoteUser,
                                                 Issue issue)
                                          throws FieldException

Description copied from interface: FieldManager

Retrieves custom fields in scope for the given issue

Specified by:

getAvailableCustomFields in interface FieldManager

Parameters:

remoteUser - Remote com.atlassian.jira.user.ApplicationUser

issue - Issue

Returns:

custom fields in scope for the given issue

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(ApplicationUser remoteUser,
                             String fieldId)

Description copied from interface: FieldManager

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 ProjectPermissions.BROWSE_PROJECTS permission).

Specified by:

isFieldHidden in interface FieldManager

Parameters:

remoteUser - the remote user.

fieldId - The Field ID

isFieldHidden

public boolean isFieldHidden(ApplicationUser remoteUser,
                             Field field)

Specified by:

isFieldHidden in interface FieldManager

getVisibleFieldLayouts

public Set<FieldLayout> getVisibleFieldLayouts(ApplicationUser user)

Description copied from interface: FieldManager

Returns all the visible FieldLayouts for the given user.

This is used in conjunction with FieldManager.isFieldHidden(Set, Field) as a performance optimisation in usages that want to call FieldManager.isFieldHidden(com.atlassian.jira.user.ApplicationUser, Field) multiple times. Instead, it is more efficient to do something like:

     Set fieldLayouts = fieldManager.getVisibleFieldLayouts(loggedInUser);
     for (Field field: myFields)
     {
       if (fieldManager.isFieldHidden(fieldLayouts1, field))
       {
           ...
       }
     }
 

Specified by:

getVisibleFieldLayouts in interface FieldManager

Parameters:

user - the user whose project browsing permissions are used to limit visible FieldLayouts.

Returns:

all the visible FieldLayouts for the given user.

isFieldHidden

public boolean isFieldHidden(Set<FieldLayout> fieldLayouts,
                             Field field)

Description copied from interface: FieldManager

Checks whether the given field is hidden in all of the given Field Layouts.

This method can be used in conjunction with FieldManager.getVisibleFieldLayouts(com.atlassian.jira.user.ApplicationUser) to provide a more performant way of looking up FieldManager.isFieldHidden(com.atlassian.jira.user.ApplicationUser, Field) multiple times. Instead, it is more efficient to do something like:

     Set fieldLayouts = fieldManager.getVisibleFieldLayouts(loggedInUser);
     for (Field field: myFields)
     {
       if (fieldManager.isFieldHidden(fieldLayouts1, field))
       {
           ...
       }
     }
 

Specified by:

isFieldHidden in interface FieldManager

Parameters:

fieldLayouts - The FieldLayouts to check

field - The field to check

Returns:

true if the given field is hidden in all of the given Field Layouts.

See Also:

FieldManager.getVisibleFieldLayouts(com.atlassian.jira.user.ApplicationUser), FieldManager.isFieldHidden(com.atlassian.jira.user.ApplicationUser, Field)

isCustomField

public boolean isCustomField(String key)

Description copied from interface: FieldManager

Returns true if the given ID is a Custom Field that actually exists in JIRA.

Specified by:

isCustomField in interface FieldManager

Parameters:

key - the field ID

Returns:

true if the given ID is a Custom Field that actually exists in JIRA.

isCustomFieldId

public boolean isCustomFieldId(String id)

Description copied from interface: FieldManager

Returns true if the given field ID is in the custom field format.

This method just checks that the ID looks like a Custom Field (it starts with "customfield_") but not that the custom field actually exists (it could have been deleted).

Specified by:

isCustomFieldId in interface FieldManager

Parameters:

id - the field ID

Returns:

true if the given ID is a Custom Field that actually exists in JIRA.

See Also:

FieldManager.isExistingCustomField(java.lang.String)

isExistingCustomField

public boolean isExistingCustomField(String id)

Description copied from interface: FieldManager

Returns true if the given ID is a Custom Field that actually exists in JIRA.

Checking for existance comes with a performance price, so use where possible.

Specified by:

isExistingCustomField in interface FieldManager

Parameters:

id - the field ID

Returns:

true if the given ID is a Custom Field that actually exists in JIRA.

See Also:

FieldManager.isCustomFieldId(java.lang.String)

isCustomField

public boolean isCustomField(Field field)

Specified by:

isCustomField in interface FieldManager

getCustomField

@Nullable
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

@Nullable
public OrderableField getOrderableField(String id)

Specified by:

getOrderableField in interface FieldManager

getConfigurableField

@Nullable
public ConfigurableField getConfigurableField(String id)

Specified by:

getConfigurableField in interface FieldManager

getOrderableFields

public Set<OrderableField> getOrderableFields()

Specified by:

getOrderableFields in interface FieldManager

getNavigableFields

public Set<NavigableField> getNavigableFields()

Specified by:

getNavigableFields 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

refresh

public void refresh()

Description copied from interface: FieldManager

Invalidates all field-related caches in JIRA.

WARNING

This method invalidates a whole lot of JIRA caches, which means that JIRA performance significantly degrades after this method has been called. For this reason, you should avoid calling this method at all costs.

The correct approach to invalidate the cache entries is to do it in the "store" inside the FooStore.updateFoo() method, where you can invalidate a single cache entry. If the cache lives in another class then the store should raise a FooUpdatedEvent which that class can listen to in order to keep its caches up to date.

If you add any calls to this method in JIRA I will hunt you down and subject you to a Spanish inquisition.

Specified by:

refresh in interface FieldManager

isTimeTrackingOn

public boolean isTimeTrackingOn()

Specified by:

isTimeTrackingOn in interface FieldManager

getUnavailableFields

public Set<Field> getUnavailableFields()

Specified by:

getUnavailableFields in interface FieldManager