|
||||||||||
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 | |
---|---|
Set<NavigableField> |
getAllAvailableNavigableFields()
Returns a set of Field s 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(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)
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). |
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 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(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. |
FieldLayoutManager |
getFieldLayoutManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead |
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()
|
boolean |
isCustomField(Field field)
|
boolean |
isCustomField(String key)
|
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)
|
protected boolean |
isSubTasksOn()
|
boolean |
isTimeTrackingOn()
|
boolean |
isUnscreenableField(Field field)
|
boolean |
isUnscreenableField(String id)
|
protected boolean |
isVotingOn()
|
protected boolean |
isWatchingOn()
|
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 Exception
Startable
start
in interface Startable
Exception
- Allows implementations to throw an Exception.@EventListener public void onClearCache(ClearCacheEvent event)
public Field getField(String id)
FieldManager
getField
in interface FieldAccessor
getField
in interface FieldManager
id
- An IssueFieldConstants
constant, or custom field key (eg. "customfield_10010")
public 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 FieldAccessor
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 Set<NavigableField> getAvailableNavigableFields(com.atlassian.crowd.embedded.api.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 FieldAccessor
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 Set<SearchableField> getAllSearchableFields()
FieldManager
getAllSearchableFields
in interface FieldAccessor
getAllSearchableFields
in interface FieldManager
public Set<SearchableField> getSystemSearchableFields()
FieldManager
getSystemSearchableFields
in interface FieldAccessor
getSystemSearchableFields
in interface FieldManager
public IssueTypeField getIssueTypeField()
FieldManager
getIssueTypeField
in interface FieldAccessor
getIssueTypeField
in interface FieldManager
public ProjectField getProjectField()
FieldManager
getProjectField
in interface FieldAccessor
getProjectField
in interface FieldManager
public Set<NavigableField> getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User user) throws FieldException
FieldManager
getAvailableNavigableFieldsWithScope
in interface FieldAccessor
getAvailableNavigableFieldsWithScope
in interface FieldManager
user
- the remote user.
FieldException
- thrown if there is a problem looking up the fieldspublic Set<NavigableField> getAvailableNavigableFieldsWithScope(com.atlassian.crowd.embedded.api.User remoteUser, QueryContext queryContext) throws FieldException
FieldManager
getAvailableNavigableFieldsWithScope
in interface FieldAccessor
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 Set<CustomField> getAvailableCustomFields(com.atlassian.crowd.embedded.api.User remoteUser, Issue issue) throws FieldException
FieldManager
getAvailableCustomFields
in interface FieldAccessor
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.atlassian.crowd.embedded.api.User remoteUser, String fieldId)
FieldManager
FieldLayout
that the user can see
(assigned to projects for which the user has the Permissions.BROWSE
permission).
isFieldHidden
in interface FieldAccessor
isFieldHidden
in interface FieldManager
remoteUser
- the remote user.fieldId
- The Field ID
public boolean isFieldHidden(com.atlassian.crowd.embedded.api.User remoteUser, Field field)
isFieldHidden
in interface FieldAccessor
isFieldHidden
in interface FieldManager
public boolean isCustomField(String key)
isCustomField
in interface FieldAccessor
isCustomField
in interface FieldManager
public boolean isCustomField(Field field)
isCustomField
in interface FieldAccessor
isCustomField
in interface FieldManager
public CustomField getCustomField(String key)
FieldManager
getCustomField
in interface FieldAccessor
getCustomField
in interface FieldManager
key
- Eg. 'customfield_10000'
CustomField
or null if not found.public boolean isHideableField(String id)
isHideableField
in interface FieldAccessor
isHideableField
in interface FieldManager
public boolean isHideableField(Field field)
isHideableField
in interface FieldAccessor
isHideableField
in interface FieldManager
public HideableField getHideableField(String id)
getHideableField
in interface FieldAccessor
getHideableField
in interface FieldManager
public boolean isOrderableField(String id)
isOrderableField
in interface FieldAccessor
isOrderableField
in interface FieldManager
public boolean isOrderableField(Field field)
isOrderableField
in interface FieldAccessor
isOrderableField
in interface FieldManager
public OrderableField getOrderableField(String id)
getOrderableField
in interface FieldAccessor
getOrderableField
in interface FieldManager
public ConfigurableField getConfigurableField(String id)
getConfigurableField
in interface FieldAccessor
getConfigurableField
in interface FieldManager
public Set<OrderableField> getOrderableFields()
getOrderableFields
in interface FieldAccessor
getOrderableFields
in interface FieldManager
public Set<NavigableField> getNavigableFields()
getNavigableFields
in interface FieldAccessor
getNavigableFields
in interface FieldManager
public boolean isNavigableField(String id)
isNavigableField
in interface FieldAccessor
isNavigableField
in interface FieldManager
public boolean isNavigableField(Field field)
isNavigableField
in interface FieldAccessor
isNavigableField
in interface FieldManager
public NavigableField getNavigableField(String id)
getNavigableField
in interface FieldAccessor
getNavigableField
in interface FieldManager
public boolean isRequirableField(String id)
isRequirableField
in interface FieldAccessor
isRequirableField
in interface FieldManager
public boolean isRequirableField(Field field)
isRequirableField
in interface FieldAccessor
isRequirableField
in interface FieldManager
public boolean isMandatoryField(String id)
isMandatoryField
in interface FieldAccessor
isMandatoryField
in interface FieldManager
public boolean isMandatoryField(Field field)
isMandatoryField
in interface FieldAccessor
isMandatoryField
in interface FieldManager
public boolean isRenderableField(String id)
isRenderableField
in interface FieldAccessor
isRenderableField
in interface FieldManager
public boolean isRenderableField(Field field)
isRenderableField
in interface FieldAccessor
isRenderableField
in interface FieldManager
public boolean isUnscreenableField(String id)
isUnscreenableField
in interface FieldAccessor
isUnscreenableField
in interface FieldManager
public boolean isUnscreenableField(Field field)
isUnscreenableField
in interface FieldAccessor
isUnscreenableField
in interface FieldManager
public RequirableField getRequiredField(String id)
getRequiredField
in interface FieldAccessor
getRequiredField
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 FieldAccessor
isTimeTrackingOn
in interface FieldManager
protected boolean isVotingOn()
protected boolean isWatchingOn()
protected boolean isSubTasksOn()
public Set<Field> getUnavailableFields()
getUnavailableFields
in interface FieldAccessor
getUnavailableFields
in interface FieldManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |