|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FieldManager
Field Summary | |
---|---|
static java.lang.String |
CUSTOM_FIELD_PREFIX
|
Method Summary | |
---|---|
java.util.Set<NavigableField> |
getAllAvailableNavigableFields()
|
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)
Deprecated. - use getAvailableCustomFields(com.opensymphony.user.User, com.atlassian.jira.issue.Issue) instead. Deprecated since v4.0. |
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)
|
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 user,
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 id)
Get a CustomField by its text key (eg 'customfield_10000'). |
CustomFieldManager |
getCustomFieldManager()
Deprecated. Declare your dependency and let PicoContainer resolve it instead |
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 id)
|
boolean |
isFieldHidden(com.opensymphony.user.User remoteUser,
Field field)
|
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)
|
boolean |
isTimeTrackingOn()
|
boolean |
isUnscreenableField(Field field)
|
boolean |
isUnscreenableField(java.lang.String id)
|
void |
refresh()
|
Field Detail |
---|
static final java.lang.String CUSTOM_FIELD_PREFIX
Method Detail |
---|
Field getField(java.lang.String id)
id
- An IssueFieldConstants
constant, or custom field key (eg. "customfield_10010")
boolean isCustomField(java.lang.String id)
boolean isCustomField(Field field)
CustomField getCustomField(java.lang.String id)
id
- Eg. 'customfield_10000'
CustomField
or null if not found.boolean isHideableField(java.lang.String id)
boolean isHideableField(Field field)
HideableField getHideableField(java.lang.String id)
boolean isOrderableField(java.lang.String id)
boolean isOrderableField(Field field)
OrderableField getOrderableField(java.lang.String id)
ConfigurableField getConfigurableField(java.lang.String id)
java.util.Set<OrderableField> getOrderableFields()
boolean isNavigableField(java.lang.String id)
boolean isNavigableField(Field field)
NavigableField getNavigableField(java.lang.String id)
boolean isRequirableField(java.lang.String id)
boolean isRequirableField(Field field)
boolean isMandatoryField(java.lang.String id)
boolean isMandatoryField(Field field)
boolean isRenderableField(java.lang.String id)
boolean isRenderableField(Field field)
boolean isUnscreenableField(java.lang.String id)
boolean isUnscreenableField(Field field)
RequirableField getRequiredField(java.lang.String id)
@Deprecated CustomFieldManager getCustomFieldManager()
@Deprecated FieldLayoutManager getFieldLayoutManager()
@Deprecated ColumnLayoutManager getColumnLayoutManager()
void refresh()
java.util.Set<Field> getUnavailableFields()
boolean isFieldHidden(com.opensymphony.user.User remoteUser, Field field) throws FieldLayoutStorageException, org.ofbiz.core.entity.GenericEntityException
FieldLayoutStorageException
org.ofbiz.core.entity.GenericEntityException
boolean isFieldHidden(com.opensymphony.user.User remoteUser, java.lang.String fieldId) throws FieldLayoutStorageException
FieldLayout
that the user can see
(assigned to projects for which the user has the Permissions.BROWSE
permission).
remoteUser
- the remote user.fieldId
- The Field ID
FieldLayoutStorageException
java.util.Set<NavigableField> getAvailableNavigableFieldsWithScope(com.opensymphony.user.User user) throws FieldException
user
- the remote user.
FieldException
- thrown if there is a problem looking up the fieldsjava.util.Set<NavigableField> getAvailableNavigableFieldsWithScope(com.opensymphony.user.User user, QueryContext queryContext) throws FieldException
user
- the user making the requestqueryContext
- the context of the search request.
FieldException
- thrown if there is a problem looking up the fieldsjava.util.Set<CustomField> getAvailableCustomFields(com.opensymphony.user.User remoteUser, Issue issue) throws FieldException
remoteUser
- Remote Userissue
- Issue
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectsjava.util.Set<CustomField> getAvailableCustomFields(com.opensymphony.user.User remoteUser, org.ofbiz.core.entity.GenericValue issue) throws FieldException
getAvailableCustomFields(com.opensymphony.user.User, com.atlassian.jira.issue.Issue)
instead. Deprecated since v4.0.
remoteUser
- Remote Userissue
- Issue
FieldException
- if cannot retrieve the projects the user can see, or if cannot retrieve
the field layouts for the viewable projectsjava.util.Set<NavigableField> getAllAvailableNavigableFields() throws FieldException
FieldException
java.util.Set<NavigableField> getAvailableNavigableFields(com.opensymphony.user.User remoteUser) throws FieldException
FieldException
java.util.Set<SearchableField> getAllSearchableFields()
java.util.Set<SearchableField> getSystemSearchableFields()
IssueTypeSystemField getIssueTypeSystemField()
ProjectSystemField getProjectSystemField()
boolean isTimeTrackingOn()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |