com.atlassian.jira.web

Interface FieldVisibilityManager

All Known Implementing Classes:

FieldVisibilityManagerImpl

public interface FieldVisibilityManager

This is an interface for the old FieldVisibilityBean. In the brave new world of OSGi and Plugins-2 we need an interface so it can proxied to the plugins. This allows it to be injected into Spring components.

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_ISSUE_TYPES

Method Summary

Modifier and Type	Method and Description
boolean	isCustomFieldHidden(Long projectId, Long customFieldId, String issueTypeId) Checks if the custom field is hidden in the project with id of projectId.
boolean	isCustomFieldVisible(Long projectId, Long customFieldId, String issueTypeId) Checks if the custom field is visible in the project with id of projectId.
boolean	isFieldHidden(ApplicationUser remoteUser, Field field) Checks if the field is hidden across all the projects that the user can see (has the Permissions.BROWSE permission).
boolean	isFieldHidden(ApplicationUser remoteUser, String id) Checks if the field is hidden across all the projects that the user can see (has the Permissions.BROWSE permission).
boolean	isFieldHidden(Long projectId, String fieldId, Long issueTypeId) Checks if the field is hidden in the project with id of projectId.
boolean	isFieldHidden(Long projectId, String fieldId, String issueTypeId) Checks if specified field is hidden in at least one scheme associated with the specified project and issue type.
boolean	isFieldHidden(String fieldId, Issue issue) Checks if the field is hidden for the issue's current field layout scheme.
boolean	isFieldHiddenInAllSchemes(Field field, SearchContext context, ApplicationUser user)
boolean	isFieldHiddenInAllSchemes(Long projectId, String fieldId)
boolean	isFieldHiddenInAllSchemes(Long projectId, String fieldId, List<String> issueTypes) Returns TRUE if specified field is hidden under the following scenarios:
boolean	isFieldHiddenInAllSchemes(String fieldId, SearchContext context, ApplicationUser user)
boolean	isFieldVisible(ApplicationUser remoteUser, Field field) Checks if the field is visible in at least one of the projects that the user can see (has the Permissions.BROWSE permission).
boolean	isFieldVisible(ApplicationUser remoteUser, String id) Checks if the field is visible in at least one of the projects that the user can see (has the Permissions.BROWSE permission).
boolean	isFieldVisible(Long projectId, String fieldId, Long issueTypeId) Checks if the field is visible in the project with id of projectId.
boolean	isFieldVisible(Long projectId, String fieldId, String issueTypeId) Checks if specified field is visible in all schemes associated with the specified project and issue type.
boolean	isFieldVisible(String fieldId, Issue issue) Checks if the field is visible for the issue's current field layout scheme.

Field Detail

ALL_ISSUE_TYPES

static final String ALL_ISSUE_TYPES

See Also:

Constant Field Values

Method Detail

isFieldHidden

boolean isFieldHidden(ApplicationUser remoteUser,
                      String id)

Checks if the field is hidden across all the projects that the user can see (has the Permissions.BROWSE permission).

Parameters:

remoteUser - user

id - the field ID

Returns:

true if the user cannot see the field across all visible projects, false otherwise

isFieldHidden

boolean isFieldHidden(ApplicationUser remoteUser,
                      Field field)

Checks if the field is hidden across all the projects that the user can see (has the Permissions.BROWSE permission).

Parameters:

remoteUser - user

field - the field

Returns:

true if the user cannot see the field across all visible projects, false otherwise

Since:

7.0

isFieldVisible

boolean isFieldVisible(ApplicationUser remoteUser,
                       String id)

Checks if the field is visible in at least one of the projects that the user can see (has the Permissions.BROWSE permission).

Parameters:

remoteUser - user

id - the field ID

Returns:

true if the user can see the field in at least one visible project, false otherwise

Since:

5.0

isFieldVisible

boolean isFieldVisible(ApplicationUser remoteUser,
                       Field field)

Checks if the field is visible in at least one of the projects that the user can see (has the Permissions.BROWSE permission).

Parameters:

remoteUser - user

field - the field

Returns:

true if the user can see the field in at least one visible project, false otherwise

Since:

5.0

isFieldHidden

boolean isFieldHidden(String fieldId,
                      Issue issue)

Checks if the field is hidden for the issue's current field layout scheme.

Parameters:

fieldId - field id

issue - issue

Returns:

true if the field is hidden, false otherwise

Since:

v3.10

isFieldVisible

boolean isFieldVisible(String fieldId,
                       Issue issue)

Checks if the field is visible for the issue's current field layout scheme.

Parameters:

fieldId - field id

issue - issue

Returns:

true if the field is visible, false otherwise

Since:

v5.0

isFieldHidden

boolean isFieldHidden(Long projectId,
                      String fieldId,
                      Long issueTypeId)

Checks if the field is hidden in the project with id of projectId.

Parameters:

projectId - project id

fieldId - field id

issueTypeId - issue type id

Returns:

true if the field is hidden, false otherwise

isFieldVisible

boolean isFieldVisible(Long projectId,
                       String fieldId,
                       Long issueTypeId)

Checks if the field is visible in the project with id of projectId.

Parameters:

projectId - project id

fieldId - field id

issueTypeId - issue type id

Returns:

true if the field is visible, false otherwise

Since:

v5.0

isFieldHidden

boolean isFieldHidden(Long projectId,
                      String fieldId,
                      String issueTypeId)

Checks if specified field is hidden in at least one scheme associated with the specified project and issue type.

Parameters:

projectId - project id

fieldId - field id

issueTypeId - issue type id

Returns:

true if the field is hidden, false otherwise

isFieldVisible

boolean isFieldVisible(Long projectId,
                       String fieldId,
                       String issueTypeId)

Checks if specified field is visible in all schemes associated with the specified project and issue type.

Parameters:

projectId - project id

fieldId - field id

issueTypeId - issue type id

Returns:

true if the field is visible, false otherwise

Since:

v5.0

isCustomFieldHidden

boolean isCustomFieldHidden(Long projectId,
                            Long customFieldId,
                            String issueTypeId)

Checks if the custom field is hidden in the project with id of projectId.

Parameters:

projectId - project id

customFieldId - the data store id of the custom field

issueTypeId - issue type id

Returns:

true if the custom field is hidden, false otherwise

isCustomFieldVisible

boolean isCustomFieldVisible(Long projectId,
                             Long customFieldId,
                             String issueTypeId)

Checks if the custom field is visible in the project with id of projectId.

Parameters:

projectId - project id

customFieldId - the data store id of the custom field

issueTypeId - issue type id

Returns:

true if the custom field is visible, false otherwise

Since:

v5.0

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(Long projectId,
                                  String fieldId,
                                  List<String> issueTypes)

Returns TRUE if specified field is hidden under the following scenarios:

1: Project specified - is field hidden in all schemes associated with the specified project.

2: Project and Issue Type(s) specified - is field hidden in all schemes associated with the specified project for the issue types specified.

Caching is abstracted to next level - all calls to getFieldLayout(...) are cached

Parameters:

projectId - project id

fieldId - field id

issueTypes - list of issue type ids (as String objects)

Returns:

true if the given field is hidden, false otherwise

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(Long projectId,
                                  String fieldId)

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(String fieldId,
                                  SearchContext context,
                                  ApplicationUser user)

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(Field field,
                                  SearchContext context,
                                  ApplicationUser user)