Summary: Methods | [Expand All]
@PublicApi public interface

StatusManager

com.atlassian.jira.config.StatusManager
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

Manager for Statuses.

Summary

Public Methods
Status createStatus(String name, String description, String iconUrl, StatusCategory statusCategory)
Creates a new status.
Status createStatus(String name, String description, String iconUrl)
Creates a new status.
void editStatus(Status status, String name, String description, String iconUrl, StatusCategory statusCategory)
Edit an existing status.
void editStatus(Status status, String name, String description, String iconUrl)
Edit an existing status.
Status getStatus(String id)
Get a status by id.
Collection<Status> getStatuses()
void removeStatus(String id)
Removes a status.

Public Methods

public Status createStatus (String name, String description, String iconUrl, StatusCategory statusCategory)

Creates a new status.

Parameters
name name of the status. Cannot be blank or null and has to be unique.
description description of the status.
iconUrl icon url for this status. Cannot be blank or null.
statusCategory status category of the status. Cannot be null
Returns

public Status createStatus (String name, String description, String iconUrl)

Creates a new status.

Parameters
name name of the status. Cannot be blank or null and has to be unique.
description description of the status.
iconUrl icon url for this status. Cannot be blank or null.
Returns

public void editStatus (Status status, String name, String description, String iconUrl, StatusCategory statusCategory)

Edit an existing status.

Parameters
status status to edit.
name new name. Has to be unique.
description new description
iconUrl new icon url
statusCategory status category of the status. Cannot be null

public void editStatus (Status status, String name, String description, String iconUrl)

Edit an existing status.

Parameters
status status to edit.
name new name. Has to be unique.
description new description
iconUrl new icon url

public Status getStatus (String id)

Get a status by id.

Parameters
id status id
Returns
  • the Status, or null if no status with this id exists.

public Collection<Status> getStatuses ()

Returns

public void removeStatus (String id)

Removes a status.

Parameters
id status id
Throws
IllegalArgumentException if this status is associated with any workflow.