com.atlassian.jira.issue.fields
Interface FieldAccessor

public interface FieldAccessor

Similar to the FieldManager, but without exposing implementation classes.

Since:

v4.3

Method Summary

Set<NavigableField>	getAllAvailableNavigableFields()
Set<SearchableField>	getAllSearchableFields() Return all the searchable fields in the system.
Set<CustomField>	getAvailableCustomFields(com.atlassian.crowd.embedded.api.User remoteUser, Issue issue) Retrieves custom fields in scope for the given issue
Set<NavigableField>	getAvailableNavigableFields(com.atlassian.crowd.embedded.api.User remoteUser)
Set<NavigableField>	getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User user) Gets all the available fields that the user can see, this is providing no context scope.
Set<NavigableField>	getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User user, QueryContext queryContext) Gets all the available fields within the defined scope of the QueryContext.
ConfigurableField	getConfigurableField(String id)
CustomField	getCustomField(String id) 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)
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()
boolean	isCustomField(Field field)
boolean	isCustomField(String id)
boolean	isFieldHidden(com.atlassian.crowd.embedded.api.User remoteUser, Field field)
boolean	isFieldHidden(com.atlassian.crowd.embedded.api.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)
boolean	isTimeTrackingOn()
boolean	isUnscreenableField(Field field)
boolean	isUnscreenableField(String id)

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

Returns:

the Field

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

getUnavailableFields

Set<Field> getUnavailableFields()

isFieldHidden

boolean isFieldHidden(com.atlassian.crowd.embedded.api.User remoteUser,
                      Field field)

isFieldHidden

boolean isFieldHidden(com.atlassian.crowd.embedded.api.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).

Parameters:

remoteUser - the remote user.

fieldId - The Field ID

Returns:

true if this field is hidden from the given user

getAvailableNavigableFieldsWithScope

Set<NavigableField> getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User user)
                                                         throws FieldException

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

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

Set<NavigableField> getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User user,
                                                         QueryContext queryContext)
                                                         throws FieldException

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

Parameters:

user - 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

Set<CustomField> getAvailableCustomFields(com.atlassian.crowd.embedded.api.User remoteUser,
                                          Issue issue)
                                          throws FieldException

Retrieves custom fields in scope for the given issue

Parameters:

remoteUser - Remote User

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

getAllAvailableNavigableFields

Set<NavigableField> getAllAvailableNavigableFields()
                                                   throws FieldException

Throws:

FieldException

getAvailableNavigableFields

Set<NavigableField> getAvailableNavigableFields(com.atlassian.crowd.embedded.api.User remoteUser)
                                                throws FieldException

Throws:

FieldException

getAllSearchableFields

Set<SearchableField> getAllSearchableFields()

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

Returns:

the set of all searchable fields in the system.

getSystemSearchableFields

Set<SearchableField> getSystemSearchableFields()

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

Returns:

the set of all searchable systems fields defined.

getIssueTypeField

IssueTypeField getIssueTypeField()

Retrieve the IssueType system Field.

Returns:

the IssueType system Field.

getProjectField

ProjectField getProjectField()

Retrieve the Project system Field.

Returns:

the Project system Field.

isTimeTrackingOn

boolean isTimeTrackingOn()