@PublicApi public interface

IssueContext

com.atlassian.jira.issue.context.IssueContext
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A context (scope) for an issue or custom field. For example, global custom fields have an IssueContext whose project and issue type are null.

Summary

Fields
public static final IssueContext GLOBAL Global context not associated with any project or any issues types.
Public Methods
@Nullable IssueType getIssueType()
Gets the IssueType for this IssueContext.
@Nullable String getIssueTypeId()
Gets the ID of the IssueType for this IssueContext.
@Nullable @Deprecated IssueType getIssueTypeObject()
This method is deprecated. Please use getIssueType(). Deprecated since v7.0
@Nullable Long getProjectId()
Gets the ID of the Project for this IssueContext.
@Nullable Project getProjectObject()
Gets the Project for this IssueContext.

Fields

public static final IssueContext GLOBAL

Global context not associated with any project or any issues types.

Public Methods

@Nullable public IssueType getIssueType ()

Gets the IssueType for this IssueContext.

A null return value is used to represent that this context applies to all IssueTypes.

Returns
  • The IssueType for this IssueContext (can be null).

@Nullable public String getIssueTypeId ()

Gets the ID of the IssueType for this IssueContext.

A null return value is used to represent that this context applies to all IssueTypes.

Returns
  • The ID of the IssueType for this IssueContext (can be null).

@Nullable @Deprecated public IssueType getIssueTypeObject ()

This method is deprecated.
Please use getIssueType(). Deprecated since v7.0

Gets the IssueType for this IssueContext.

A null return value is used to represent that this context applies to all IssueTypes.

Returns
  • The IssueType for this IssueContext (can be null).

@Nullable public Long getProjectId ()

Gets the ID of the Project for this IssueContext.

A null return value is used to represent that this context applies to all Projects.

Returns
  • The ID of the Project for this IssueContext (can be null).

@Nullable public Project getProjectObject ()

Gets the Project for this IssueContext.

A null return value is used to represent that this context applies to all Projects.

Returns
  • The Project for this IssueContext (can be null).