com.atlassian.jira.web
Interface FieldVisibilityManager

All Known Implementing Classes:
FieldVisibilityBean, 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
static java.lang.String ALL_ISSUE_TYPES
           
 
Method Summary
 boolean isCustomFieldHidden(java.lang.Long projectId, java.lang.Long customFieldId, java.lang.String issueTypeId)
          Checks if the custom field is hidden in the project with id of projectId.
 boolean isFieldHidden(java.lang.Long projectId, java.lang.String fieldId, java.lang.Long issueTypeId)
          Checks if the field is hidden in the project with id of projectId.
 boolean isFieldHidden(java.lang.Long projectId, java.lang.String fieldId, java.lang.String issueTypeId)
          Checks if specified field is hidden in at least one scheme associated with the specified project and issue type.
 boolean isFieldHidden(java.lang.String fieldId, org.ofbiz.core.entity.GenericValue issue)
          Checks if the field is hidden for the issue's current field layout scheme
 boolean isFieldHidden(java.lang.String fieldId, Issue issue)
          Checks if the field is hidden for the issue's current field layout scheme.
 boolean isFieldHidden(com.opensymphony.user.User remoteUser, java.lang.String id)
          Checks if the field is hidden or visible across all the projects that the user can see (has the Permissions.BROWSE permission).
 boolean isFieldHiddenInAllSchemes(java.lang.Long projectId, java.lang.String fieldId)
           
 boolean isFieldHiddenInAllSchemes(java.lang.Long projectId, java.lang.String fieldId, java.util.List 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.

 boolean isFieldHiddenInAllSchemes(java.lang.String fieldId, SearchContext context, com.opensymphony.user.User user)
           
 

Field Detail

ALL_ISSUE_TYPES

static final java.lang.String ALL_ISSUE_TYPES
See Also:
Constant Field Values
Method Detail

isFieldHidden

boolean isFieldHidden(com.opensymphony.user.User remoteUser,
                      java.lang.String id)
                      throws FieldLayoutStorageException
Checks if the field is hidden or visible across all the projects that the user can see (has the Permissions.BROWSE permission).

Parameters:
remoteUser - user
id - id of the FieldConfiguration
Returns:
true if the user cannot see the field across all visible projects, false otherwise
Throws:
FieldLayoutStorageException - if the vibility check fails

isFieldHidden

boolean isFieldHidden(java.lang.String fieldId,
                      org.ofbiz.core.entity.GenericValue issue)
Checks if the field is hidden for the issue's current field layout scheme

Parameters:
fieldId - the field id of the field in question
issue - issue generic value, not null
Returns:
true if the field is hidden, false otherwise

isFieldHidden

boolean isFieldHidden(java.lang.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

isCustomFieldHidden

boolean isCustomFieldHidden(java.lang.Long projectId,
                            java.lang.Long customFieldId,
                            java.lang.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

isFieldHidden

boolean isFieldHidden(java.lang.Long projectId,
                      java.lang.String fieldId,
                      java.lang.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

isFieldHidden

boolean isFieldHidden(java.lang.Long projectId,
                      java.lang.String fieldId,
                      java.lang.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

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(java.lang.Long projectId,
                                  java.lang.String fieldId,
                                  java.util.List 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(java.lang.Long projectId,
                                  java.lang.String fieldId)

isFieldHiddenInAllSchemes

boolean isFieldHiddenInAllSchemes(java.lang.String fieldId,
                                  SearchContext context,
                                  com.opensymphony.user.User user)


Copyright © 2002-2010 Atlassian. All Rights Reserved.