com.valiantys.nfeed.api

Interface IFieldValueService

public interface IFieldValueService

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

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

Method Summary

Modifier and Type	Method and Description
Collection<?>	getFieldValues(String issueKey, String customFieldId) Returns the values contained in the nFeed custom field.
void	setFieldValue(String issueKey, String customFieldId, Object fieldValue) Sets a nFeed custom field value.
void	setFieldValues(String issueKey, String customFieldId, Collection<?> fieldValues) Sets a nFeed custom field values.

Method Detail

setFieldValue

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

Sets a nFeed 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 nFeed 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 a nFeed 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 nFeed 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 a nFeed field, the method returns an empty list.

Parameters:

issueKey - the issue key

customFieldId - the custom field id

Returns:

a collection of values