|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.fields.DefaultFieldManager
public class DefaultFieldManager
Field Summary |
---|
Fields inherited from interface com.atlassian.jira.issue.fields.FieldManager |
---|
CUSTOM_FIELD_PREFIX |
Constructor Summary | |
---|---|
DefaultFieldManager(com.atlassian.event.api.EventPublisher eventPublisher)
|
Method Summary | |
---|---|
java.util.Set<NavigableField> |
getAllAvailableNavigableFields()
Returns a set of Field s that are NOT hidden in AT LEAST ONE project in the system. |
java.util.Set<SearchableField> |
getAllSearchableFields()
Return all the searchable fields in the system. |
java.util.Set<CustomField> |
getAvailableCustomFields(com.opensymphony.user.User remoteUser,
org.ofbiz.core.entity.GenericValue issue)
Retrieves custom fields in scope for the given issue |
java.util.Set<CustomField> |
getAvailableCustomFields(com.opensymphony.user.User remoteUser,
Issue issue)
Retrieves custom fields in scope for the given issue |
java.util.Set<NavigableField> |
getAvailableNavigableFields(com.opensymphony.user.User remoteUser)
Returns a set of Field s that are NOT hidden in AT LEAST ONE project that
the remote user can see (has Permissions.BROWSE permission for). |
java.util.Set<NavigableField> |
getAvailableNavigableFieldsWithScope(com.opensymphony.user.User user)
Gets all the available fields that the user can see, this is providing no context scope. |
java.util.Set<NavigableField> |
getAvailableNavigableFieldsWithScope(com.opensymphony.user.User remoteUser,
QueryContext queryContext)
Gets all the available fields within the defined scope of the QueryContext. |
ColumnLayoutManager |
getColumnLayoutManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead |
ConfigurableField |
getConfigurableField(java.lang.String id)
|
CustomField |
getCustomField(java.lang.String key)
Get a CustomField by its text key (eg 'customfield_10000'). |
CustomFieldManager |
getCustomFieldManager()
|
Field |
getField(java.lang.String id)
Get a field by its id. |
FieldLayoutManager |
getFieldLayoutManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead |
HideableField |
getHideableField(java.lang.String id)
|
IssueTypeSystemField |
getIssueTypeSystemField()
|
NavigableField |
getNavigableField(java.lang.String id)
|
OrderableField |
getOrderableField(java.lang.String id)
|
java.util.Set<OrderableField> |
getOrderableFields()
|
ProjectSystemField |
getProjectSystemField()
|
RequirableField |
getRequiredField(java.lang.String id)
|
java.util.Set<SearchableField> |
getSystemSearchableFields()
Return all the searchable systems fields. |
java.util.Set<Field> |
getUnavailableFields()
|
boolean |
isCustomField(Field field)
|
boolean |
isCustomField(java.lang.String key)
|
boolean |
isFieldHidden(com.opensymphony.user.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(com.opensymphony.user.User remoteUser,
java.lang.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(java.lang.String id)
|
boolean |
isMandatoryField(Field field)
|
boolean |
isMandatoryField(java.lang.String id)
|
boolean |
isNavigableField(Field field)
|
boolean |
isNavigableField(java.lang.String id)
|
boolean |
isOrderableField(Field field)
|
boolean |
isOrderableField(java.lang.String id)
|
boolean |
isRenderableField(Field field)
|
boolean |
isRenderableField(java.lang.String id)
|
boolean |
isRequirableField(Field field)
|
boolean |
isRequirableField(java.lang.String id)
|
protected boolean |
isSubTasksOn()
|
boolean |
isTimeTrackingOn()
|
boolean |
isUnscreenableField(Field field)
|
boolean |
isUnscreenableField(java.lang.String id)
|
protected boolean |
isVotingOn()
|
void |
onClearCache(ClearCacheEvent event)
|
void |
refresh()
|
void |
start()
This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultFieldManager(com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail |
---|
public void start() throws java.lang.Exception
Startable
start
in interface Startable
java.lang.Exception
- Allows implementations to throw an Exception.@EventListener public void onClearCache(ClearCacheEvent event)
public Field getField(java.lang.String id)
FieldManager
getField
in interface FieldManager
id
- An IssueFieldConstants
constant, or custom field key (eg. "customfield_10010")
public java.util.Set<NavigableField> getAllAvailableNavigableFields() throws FieldException
Field
s 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
getAllAvailableNavigableFields
in interface FieldManager
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectspublic java.util.Set<NavigableField> getAvailableNavigableFields(com.opensymphony.user.User remoteUser) throws FieldException
Field
s 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.
getAvailableNavigableFields
in interface FieldManager
remoteUser
- the remote user
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectspublic java.util.Set<SearchableField> getAllSearchableFields()
FieldManager
getAllSearchableFields
in interface FieldManager
public java.util.Set<SearchableField> getSystemSearchableFields()
FieldManager
getSystemSearchableFields
in interface FieldManager
public IssueTypeSystemField getIssueTypeSystemField()
getIssueTypeSystemField
in interface FieldManager
public ProjectSystemField getProjectSystemField()
getProjectSystemField
in interface FieldManager
public java.util.Set<NavigableField> getAvailableNavigableFieldsWithScope(com.opensymphony.user.User user) throws FieldException
FieldManager
getAvailableNavigableFieldsWithScope
in interface FieldManager
user
- the remote user.
FieldException
- thrown if there is a problem looking up the fieldspublic java.util.Set<NavigableField> getAvailableNavigableFieldsWithScope(com.opensymphony.user.User remoteUser, QueryContext queryContext) throws FieldException
FieldManager
getAvailableNavigableFieldsWithScope
in interface FieldManager
remoteUser
- the user making the requestqueryContext
- the context of the search request.
FieldException
- thrown if there is a problem looking up the fieldspublic java.util.Set<CustomField> getAvailableCustomFields(com.opensymphony.user.User remoteUser, org.ofbiz.core.entity.GenericValue issue) throws FieldException
FieldManager
getAvailableCustomFields
in interface FieldManager
remoteUser
- Remote Userissue
- Issue
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectspublic java.util.Set<CustomField> getAvailableCustomFields(com.opensymphony.user.User remoteUser, Issue issue) throws FieldException
FieldManager
getAvailableCustomFields
in interface FieldManager
remoteUser
- Remote Userissue
- Issue
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectspublic boolean isFieldHidden(com.opensymphony.user.User remoteUser, java.lang.String fieldId) throws FieldLayoutStorageException
FieldManager
FieldLayout
that the user can see
(assigned to projects for which the user has the Permissions.BROWSE
permission).
isFieldHidden
in interface FieldManager
remoteUser
- the remote user.fieldId
- The Field ID
FieldLayoutStorageException
public boolean isFieldHidden(com.opensymphony.user.User remoteUser, Field field) throws FieldLayoutStorageException
FieldLayout
that the user can see
(assigned to projects for which the user has the Permissions.BROWSE
permission).
isFieldHidden
in interface FieldManager
remoteUser
- the remote user.field
-
FieldLayoutStorageException
public boolean isCustomField(java.lang.String key)
isCustomField
in interface FieldManager
public boolean isCustomField(Field field)
isCustomField
in interface FieldManager
public CustomField getCustomField(java.lang.String key)
FieldManager
getCustomField
in interface FieldManager
key
- Eg. 'customfield_10000'
CustomField
or null if not found.public boolean isHideableField(java.lang.String id)
isHideableField
in interface FieldManager
public boolean isHideableField(Field field)
isHideableField
in interface FieldManager
public HideableField getHideableField(java.lang.String id)
getHideableField
in interface FieldManager
public boolean isOrderableField(java.lang.String id)
isOrderableField
in interface FieldManager
public boolean isOrderableField(Field field)
isOrderableField
in interface FieldManager
public OrderableField getOrderableField(java.lang.String id)
getOrderableField
in interface FieldManager
public ConfigurableField getConfigurableField(java.lang.String id)
getConfigurableField
in interface FieldManager
public java.util.Set<OrderableField> getOrderableFields()
getOrderableFields
in interface FieldManager
public boolean isNavigableField(java.lang.String id)
isNavigableField
in interface FieldManager
public boolean isNavigableField(Field field)
isNavigableField
in interface FieldManager
public NavigableField getNavigableField(java.lang.String id)
getNavigableField
in interface FieldManager
public boolean isRequirableField(java.lang.String id)
isRequirableField
in interface FieldManager
public boolean isRequirableField(Field field)
isRequirableField
in interface FieldManager
public boolean isMandatoryField(java.lang.String id)
isMandatoryField
in interface FieldManager
public boolean isMandatoryField(Field field)
isMandatoryField
in interface FieldManager
public boolean isRenderableField(java.lang.String id)
isRenderableField
in interface FieldManager
public boolean isRenderableField(Field field)
isRenderableField
in interface FieldManager
public boolean isUnscreenableField(java.lang.String id)
isUnscreenableField
in interface FieldManager
public boolean isUnscreenableField(Field field)
isUnscreenableField
in interface FieldManager
public RequirableField getRequiredField(java.lang.String id)
getRequiredField
in interface FieldManager
public CustomFieldManager getCustomFieldManager()
getCustomFieldManager
in interface FieldManager
@Deprecated public FieldLayoutManager getFieldLayoutManager()
getFieldLayoutManager
in interface FieldManager
@Deprecated public ColumnLayoutManager getColumnLayoutManager()
getColumnLayoutManager
in interface FieldManager
public void refresh()
refresh
in interface FieldManager
public boolean isTimeTrackingOn()
isTimeTrackingOn
in interface FieldManager
protected boolean isVotingOn()
protected boolean isSubTasksOn()
public java.util.Set<Field> getUnavailableFields()
getUnavailableFields
in interface FieldManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |