com.atlassian.jira.config
Interface StatusManager

All Known Implementing Classes:

DefaultStatusManager

@PublicApi
public interface StatusManager

Manager for Statuses.

Since:

v5.0

Method Summary

Status	createStatus(String name, String description, String iconUrl) Creates a new 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.

Method Detail

createStatus

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:

the new Status.

editStatus

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

getStatuses

Collection<Status> getStatuses()

Returns:

all Statuses

removeStatus

void removeStatus(String id)

Removes a status.

Parameters:

id - status id

Throws:

IllegalArgumentException - if this status is associated with any workflow.

getStatus

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.