com.valiantys.nfeed.api

Interface IFieldValueService

public interface IFieldValueService

This service gives access to Elements Connect custom field value. Using the methods below, you can set and get custom field content. The value type must match the Elements Connect custom field type :

• Elements Connect : java.lang.String (key content)
• Elements Connect legacy : java.lang.String (key content)
• Elements Connect Date : java.util.Date
• Elements Connect DateTime: java.util.Date
• Elements Connect User : com.atlassian.jira.ApplicationUser

Method Summary

Modifier and Type	Method and Description
void	computeFieldsValue(String issueKey, List<String> customFieldsIds) Retrieve all custom fields from passed custom fields ids and compute their values according to the given issue.
String	getDbValue(String issueKey, String customFieldId) Returns Elements Connect custom field string value as it is stored in Jira database.
Collection<?>	getFieldValues(String issueKey, String customFieldId) Returns the values contained in the Elements Connect custom field.
void	setFieldValue(String issueKey, String customFieldId, Object fieldValue) Sets a Elements Connect custom field value.
void	setFieldValues(String issueKey, String customFieldId, Collection<?> fieldValues) Sets a Elements Connect custom field values.

Method Detail

setFieldValue

void setFieldValue(String issueKey,
                   String customFieldId,
                   Object fieldValue)

Sets a Elements Connect custom field value. This works exactly the same as using setFieldValues(String, String, Collection) with a Collection containing this single element. Setting null will set an empty collection.

Parameters:

issueKey - The issue key

customFieldId - the custom field id (customfield_XXX)

fieldValue - the field value.

setFieldValues

void setFieldValues(String issueKey,
                    String customFieldId,
                    Collection<?> fieldValues)

Sets a Elements Connect custom field values. The values must match the type of the custom field (see class declaration javadoc). When setting values on a single value field, only the first value in the collection will be taken into account. If the issue does not exist or if the custom field does not exist or is not an Elements Connect field, the method has no effect.

Parameters:

issueKey - the issue key

customFieldId - the custom field id

fieldValues - a collection of values

getFieldValues

Collection<?> getFieldValues(String issueKey,
                             String customFieldId)

Returns the values contained in the Elements Connect custom field. Single value field return a collection with at most one value. If the issue does not exist or if the custom field does not exist or is not an Elements Connect field, the method returns an empty list.

Parameters:

issueKey - the issue key

customFieldId - the custom field id

Returns:

a collection of values

computeFieldsValue

void computeFieldsValue(String issueKey,
                        List<String> customFieldsIds)

Retrieve all custom fields from passed custom fields ids and compute their values according to the given issue. If the issue does not exist or if the custom field does not exist or is not an Elements Connect field, the method has no effect.

Parameters:

issueKey - the issue key

customFieldsIds - a list of custom field id

getDbValue

String getDbValue(String issueKey,
                  String customFieldId)

Returns Elements Connect custom field string value as it is stored in Jira database. If the issue does not exist or if the custom field does not exist or is not an Elements Connect field, the method returns null.

Parameters:

issueKey - the issue key

customFieldId - the custom field id

Returns:

the value stored in database