com.valiantys.nfeed.api

Interface IFieldDisplayService

public interface IFieldDisplayService

Service allowing generation of Elements Connect fields display values.
A display value is the value displayed to a user on an issue display view.

Example usage:

 
 FieldDisplayResult displayResult = fieldDisplayService.getDisplayResult("ISSUE-12345", "customfield_10000");
 String displayValue = displayResult.getDisplay();
 
     

See Also:

FieldDisplayResult

Method Summary

Modifier and Type	Method and Description
FieldDisplayResult	getDisplayResult(Long issueId, String customFieldId) Retrieves the display value of an Elements Connect custom field for issue view.
FieldDisplayResult	getDisplayResult(String issueKey, String customFieldId) Retrieves the display value of an Elements Connect custom field for issue view.
FieldDisplayResult	getDisplayResultOverrideSecurity(Long issueId, String customFieldId) Retrieves the display value of an Elements Connect custom field for issue view overriding user permissions.
FieldDisplayResult	getDisplayResultOverrideSecurity(String issueKey, String customFieldId) Retrieves the display value of an Elements Connect custom field for issue view overriding user permissions.

Method Detail

getDisplayResult

FieldDisplayResult getDisplayResult(Long issueId,
                                    String customFieldId)

Retrieves the display value of an Elements Connect custom field for issue view.

Parameters:

issueId - id of issue to retrieve display value from

customFieldId - id of Elements Connect custom field (customfield_XXX)

Returns:

the display result FieldDisplayResult

getDisplayResult

FieldDisplayResult getDisplayResult(String issueKey,
                                    String customFieldId)

Retrieves the display value of an Elements Connect custom field for issue view.

Parameters:

issueKey - key of issue to retrieve display value from

customFieldId - id of Elements Connect custom field (customfield_XXX)

Returns:

the display result FieldDisplayResult

getDisplayResultOverrideSecurity

FieldDisplayResult getDisplayResultOverrideSecurity(Long issueId,
                                                    String customFieldId)

Retrieves the display value of an Elements Connect custom field for issue view overriding user permissions.

Parameters:

issueId - id of issue to retrieve display value from

customFieldId - id of Elements Connect custom field (customfield_XXX)

Returns:

the display result FieldDisplayResult

getDisplayResultOverrideSecurity

FieldDisplayResult getDisplayResultOverrideSecurity(String issueKey,
                                                    String customFieldId)

Retrieves the display value of an Elements Connect custom field for issue view overriding user permissions.

Parameters:

issueKey - key of issue to retrieve display value from

customFieldId - id of Elements Connect custom field (customfield_XXX)

Returns:

the display result FieldDisplayResult