|
static
boolean
|
areDifferent(Object obj1, Object obj2)
Compare two objects - return false if both are null or equal.
|
|
String
|
availableForBulkEdit(BulkEditBean bulkEditBean)
Checks if custom field is available for bulk edit operation, whether 'shown' and if user has bulk update permission.
|
|
boolean
|
canRemoveValueFromIssueObject(Issue issue)
|
|
int
|
compare(Issue issue1, Issue issue2)
This method compares the values of this custom field in two given issues.
|
|
int
|
compareTo(Object o)
|
|
GenericValue
|
copyGenericValue()
Non-public method that returns a copy of the underlying GenericValue.
|
|
SearchHandler
|
createAssociatedSearchHandler()
|
|
void
|
createValue(Issue issue, Object value)
Create the value of the issue in the data store.
|
|
boolean
|
equals(Object o)
|
|
List<GenericValue>
|
getAssociatedIssueTypes()
Returns a list of issue types associated with this custom field.
|
|
List<GenericValue>
|
getAssociatedProjectCategories()
Returns a list of associated project categories for this custom field.
|
|
List<ProjectCategory>
|
getAssociatedProjectCategoryObjects()
Returns a list of associated project categories for this custom field.
|
|
List<Project>
|
getAssociatedProjectObjects()
Returns a list of projects associated with this custom field.
|
|
List<GenericValue>
|
getAssociatedProjects()
Returns a list of projects associated with this custom field.
|
|
String
|
getBulkEditHtml(OperationContext operationContext, Action action, BulkEditBean bulkEditBean, Map displayParameters)
Returns HTML that should be shown when the issue is being bulk edited.
|
|
ClauseNames
|
getClauseNames()
Return the JQL clause names that this custom field should be recognized by.
|
|
String
|
getColumnCssClass()
|
|
String
|
getColumnHeadingKey()
|
|
String
|
getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
|
|
List
|
getConfigurationItemTypes()
|
|
List<FieldConfigScheme>
|
getConfigurationSchemes()
Returns a list of configuration schemes.
|
|
String
|
getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map dispayParameters)
Returns the HTML that should be shown when the issue is being created.
|
|
String
|
getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue)
Returns the HTML that should be shown when the issue is being created.
|
|
CustomFieldSearcher
|
getCustomFieldSearcher()
|
|
CustomFieldType
|
getCustomFieldType()
|
|
CustomFieldParams
|
getCustomFieldValues(Map customFieldValuesHolder)
Get the custom field string values that are relevant to this particular custom field
|
|
String
|
getDefaultSortOrder()
|
|
Object
|
getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason.
|
|
String
|
getDescription()
Returns the i18n'ed description of this custom field.
|
|
@Nonnull
RenderableProperty
|
getDescriptionProperty()
Returns a RenderableProperty for rendering this custom field's description.
|
|
String
|
getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map dispayParameters)
Returns HTML that should be shown when the issue is being edited.
|
|
String
|
getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue)
Returns HTML that should be shown when the issue is being edited.
|
|
EventPublisher
|
getEventPublisher()
Overridable location to retrieve an EventPublisher to publish events through.
|
|
String
|
getFieldName()
Returns the title of this custom field.
|
|
FieldTypeInfo
|
getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
Returns lower level Information about the field.
|
|
GenericValue
|
getGenericValue()
Returns a generic value that represents this custom field.
|
|
String
|
getHiddenFieldId()
Returns the id of the field to check for visibility.
|
|
I18nHelper
|
getI18nHelper()
|
|
String
|
getId()
Returns the identifier for this RenderableField.
|
|
Long
|
getIdAsLong()
Returns ID of this custom field.
|
|
JsonData
|
getJsonDefaultValue(IssueContext issueCtx)
Return The default data for this system field.
|
|
FieldJsonRepresentation
|
getJsonFromIssue(Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem)
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation
of the rendered data for easy display.
|
|
JsonType
|
getJsonSchema()
Return a description of the shape of this field when represented as JSON.
|
|
String
|
getName()
Returns the name of this custom field.
|
|
String
|
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed
|
|
Options
|
getOptions(String key, FieldConfig config, JiraContextNode contextNode)
|
|
Options
|
getOptions(String key, JiraContextNode jiraContextNode)
|
|
static
String
|
getParamKeyIssueId()
Name of the parameter that stores the issue id in the current context in CustomFieldParams.
|
|
static
String
|
getParamKeyProjectId()
Name of the parameter that stores the project id of the associated issue in the current context in CustomFieldParams.
|
|
PropertySet
|
getPropertySet()
|
|
FieldConfig
|
getRelevantConfig(IssueContext issueContext)
Returns the relevant field config of this custom field for the give issue context
|
|
FieldConfig
|
getRelevantConfig(Issue issue)
|
|
CustomFieldParams
|
getRelevantParams(Map<String, String[]> params)
Returns custom field parameter from the given map that are relevant to this custom field.
|
|
FieldConfig
|
getReleventConfig(SearchContext searchContext)
Return the relevant field config for the search context specified.
|
|
RestFieldOperationsHandler
|
getRestFieldOperation()
|
|
FieldComparatorSource
|
getSortComparatorSource()
|
|
List<SortField>
|
getSortFields(boolean sortOrder)
Return a list of Lucene SortFields to be used for sorting search results.
|
|
LuceneFieldSorter
|
getSorter()
|
|
String
|
getUntranslatedDescription()
Returns the description of this custom field by reading ENTITY_DESCRIPTION of the underlying generic value. |
|
@Nonnull
RenderableProperty
|
getUntranslatedDescriptionProperty()
Returns a RenderableProperty for rendering this custom field's description.
|
|
String
|
getUntranslatedName()
Returns the name of this custom field by reading ENTITY_NAME of the underlying generic value. |
|
Object
|
getValue(Issue issue)
Retrieves and returns the Object representing the this CustomField value for the given issue.
|
|
String
|
getValueFromIssue(Issue issue)
Gets the value stored for this field on the provided issue.
|
|
Object
|
getValueFromParams(Map params)
Get a field value from the map of parameters passed.
|
|
String
|
getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue)
|
|
String
|
getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Object value, Map displayParameters)
|
|
String
|
getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Map displayParameters)
|
|
boolean
|
hasBulkUpdatePermission(BulkEditBean bulkEditBean, Issue issue)
Checks whether the user has the permission to execute the bulk operation for the provided issue.
|
|
boolean
|
hasParam(Map parameters)
|
|
boolean
|
hasValue(Issue issue)
Determines if the field has a value for the given issue.
|
|
int
|
hashCode()
|
|
boolean
|
isAllIssueTypes()
Returns true if it applies for all issue types, false otherwise.
|
|
boolean
|
isAllProjects()
Checks whether this custom field applies for all projects.
|
|
boolean
|
isEditable()
Returns true if this custom field has an edit template, false otherwise.
|
|
boolean
|
isEnabled()
|
|
boolean
|
isGlobal()
Returns true if this custom field applies for all projects and all issue types.
|
|
boolean
|
isInScope(SearchContext searchContext)
Determines whether this custom field is in scope.
|
|
final
boolean
|
isInScope(User user, SearchContext searchContext)
|
|
@Deprecated
final
boolean
|
isInScope(GenericValue project, List issueTypeIds)
|
|
boolean
|
isInScope(Project project, List<String> issueTypeIds)
Determines if this custom field is within the scope of the given project, and list of Issue Types.
|
|
boolean
|
isRenderable()
This is the conjunction point with CustomFieldTypes and this is delegated off to customField Types.
|
|
boolean
|
isShown(Issue issue)
Tests field specific way to determine if it should be shown or not.
|
|
MessagedResult
|
needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
Used to determine if the field needs input from user to be moved to the new project and/or issue type.
|
|
void
|
populateDefaults(Map<String, Object> customFieldValuesHolder, Issue issue)
Populate the fieldValueHolder with a value that should be shown by default when the issue
has not been created yet.
|
|
void
|
populateForMove(Map<String, Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
Used to populate the fieldValueHolder with parameters for move issue screen.
|
|
void
|
populateFromIssue(Map<String, Object> customFieldValuesHolder, Issue issue)
Puts the custom field parameters retrieved from the given issue to the given customFieldValuesHolder map.
|
|
void
|
populateFromParams(Map<String, Object> customFieldValuesHolder, Map<String, String[]> params)
Puts the relevant parameters from the given params map to the given customFieldValuesHolder map.
|
|
void
|
populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue)
Does nothing.
|
|
String
|
prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)
Returns the same string.
|
|
String
|
prettyPrintChangeHistory(String changeHistory)
Returns the same string.
|
|
@Deprecated
Set<Long>
|
remove()
|
|
void
|
removeValueFromIssueObject(MutableIssue issue)
Removes the field value from the given MutableIssue object.
|
|
void
|
setCustomFieldSearcher(CustomFieldSearcher searcher)
|
|
void
|
setDescription(String description)
Sets the description of this custom field by setting the ENTITY_DESCRIPTION of the underlying generic
value. |
|
void
|
setName(String name)
Sets the name of this custom field by setting the ENTITY_NAME of the underlying generic value. |
|
@Deprecated
void
|
store()
|
|
String
|
toString()
|
|
void
|
updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
Record the value on the issue (not saving it to the database, see updateValue).
|
|
void
|
updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
Update the issue in the data store.
|
|
void
|
validateFromActionParams(Map actionParameters, ErrorCollection errorCollection, FieldConfig config)
Validates relevant parameters on custom field type of this custom field.
|
|
void
|
validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid
|
From interface
com.atlassian.jira.issue.fields.CustomField