Package com.atlassian.jira.plugin.issueview

Interface IssueViewFieldParams

All Known Implementing Classes:
IssueViewFieldParamsImpl
public interface IssueViewFieldParams
The purpose of this interface is to provide information about requested fields to @{link IssueView#getContent} and @{link IssueView#wriiteHeaders} methods. Requested fields are evaluated based on "field" url parameters in @{link IssueViewReqestParamsHelperImpl#getIssueViewFieldParams} method
Since:
v4.00

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getCustomFieldIds()
    Method returns set of custom field ids requested for view.
    Set<String>
    getFieldIds()
    Method returns set of field ids requested for view.
    Set<String>
    getOrderableFieldIds()
    Method returns set of orderable field ids requested for view.
    boolean
    isAllCustomFields()
    Method returns true if allcustom parameter in url was specified, otherwise false
    boolean
    isAnyFieldDefined()
    Method returns true if any valid field was specified in url parameters
    boolean
    isCustomViewRequested()
    Method returns true if custom issue view was requested by specyfing "field" parameter in request url

  • Method Details

    • getFieldIds

      Set<String> getFieldIds()
      Method returns set of field ids requested for view. Set contains all field ids including non-orderable fields
      Returns:
      set of non-custom field ids requested in view parameters

    • getCustomFieldIds

      Set<String> getCustomFieldIds()
      Method returns set of custom field ids requested for view.
      Returns:
      set of custom field ids requested in view parameters

    • getOrderableFieldIds

      Set<String> getOrderableFieldIds()
      Method returns set of orderable field ids requested for view.
      Returns:
      set of orderable field ids requested in view parameters

    • isAllCustomFields

      boolean isAllCustomFields()
      Method returns true if allcustom parameter in url was specified, otherwise false
      Returns:
      true if allcustom parameter in url was specified, otherwise false

    • isAnyFieldDefined

      boolean isAnyFieldDefined()
      Method returns true if any valid field was specified in url parameters
      Returns:
      true if any valid field was requested

    • isCustomViewRequested

      boolean isCustomViewRequested()
      Method returns true if custom issue view was requested by specyfing "field" parameter in request url
      Returns:
      true if custom issue view was requested