@PublicApi
public interface StatusService
Status
es with validationModifier and Type | Field and Description |
---|---|
static int |
MAX_STATUS_LENGTH
Maximum length allowed for the name of a status.
|
Modifier and Type | Method and Description |
---|---|
ServiceOutcome<Status> |
createStatus(ApplicationUser user,
String name,
String description,
String iconUrl,
StatusCategory statusCategory)
Validates and when validation is performed successfully creates new status basing on given parameters
|
ServiceOutcome<Status> |
editStatus(ApplicationUser user,
Status status,
String name,
String description,
String iconUrl,
StatusCategory statusCategory)
Validates and when validation is performed successfully alters given status basing on given parameters
|
java.util.stream.Stream<Status> |
findStatuses(String substring,
Set<Long> projectIds,
Set<String> issueTypeIds)
Returns statuses whose names start with or fully match given substring.
|
ServiceOutcome<List<JiraWorkflow>> |
getAssociatedWorkflows(ApplicationUser user,
Status status)
Gets a list of workflows which contains given status
|
Status |
getStatusById(ApplicationUser user,
String id)
Get a status by id.
|
boolean |
isStatusAsLozengeEnabled()
Returns a boolean whether status lozenge is enabled or not
|
ServiceResult |
moveStatusDown(ApplicationUser user,
String id)
Move a status down the order.
|
ServiceResult |
moveStatusUp(ApplicationUser user,
String id)
Move a status up the order.
|
ServiceResult |
removeStatus(ApplicationUser user,
Status status)
Removes a status.
|
ServiceResult |
validateCreateStatus(ApplicationUser user,
String name,
String description,
String iconUrl,
StatusCategory statusCategory)
Validates new status basing on given parameters
|
ServiceResult |
validateEditStatus(ApplicationUser user,
Status status,
String name,
String description,
String iconUrl,
StatusCategory statusCategory)
Validates given status basing on given parameters
|
ServiceResult |
validateRemoveStatus(ApplicationUser user,
Status status)
Validates removal of given status
|
static final int MAX_STATUS_LENGTH
ServiceOutcome<Status> createStatus(ApplicationUser user, String name, String description, String iconUrl, StatusCategory statusCategory)
user
- User performing operationname
- Name of the status. Should neither be blank nor duplicate existing namedescription
- Optional description of the statusiconUrl
- URL of the icon for representing given status. May be relative or absolute. Cannot be nullstatusCategory
- StatusCategory
for given status. Cannot be nullvalidateCreateStatus(com.atlassian.jira.user.ApplicationUser, String, String, String, com.atlassian.jira.issue.status.category.StatusCategory)
ServiceResult validateCreateStatus(ApplicationUser user, String name, String description, String iconUrl, StatusCategory statusCategory)
user
- User performing operationname
- Name of the status. Should neither be blank nor duplicate existing namedescription
- Optional description of the statusiconUrl
- URL of the icon for representing given status. May be relative or absolute. Cannot be nullstatusCategory
- StatusCategory
for given status. Cannot be nullServiceOutcome<Status> editStatus(ApplicationUser user, Status status, String name, String description, String iconUrl, StatusCategory statusCategory)
user
- User performing operationstatus
- The status to be editedname
- Name of the status. Should neither be blank nor duplicate existing namedescription
- Optional description of the statusiconUrl
- URL of the icon for representing given status. May be relative or absolute. Cannot be nullstatusCategory
- StatusCategory
for given status. Cannot be nullvalidateEditStatus(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.status.Status, String, String, String, com.atlassian.jira.issue.status.category.StatusCategory)
ServiceResult validateEditStatus(ApplicationUser user, Status status, String name, String description, String iconUrl, StatusCategory statusCategory)
user
- User performing operationstatus
- The status to be editedname
- Name of the status. Should neither be blank nor duplicate existing namedescription
- Optional description of the statusiconUrl
- URL of the icon for representing given status. May be relative or absolute. Cannot be nullstatusCategory
- StatusCategory
for given status. Cannot be nullStatus getStatusById(ApplicationUser user, String id)
user
- User performing operationid
- status idStatus
, or null if no status with this id exists.ServiceResult removeStatus(ApplicationUser user, Status status)
user
- User performing operationstatus
- StatusServiceResult validateRemoveStatus(ApplicationUser user, Status status)
user
- User performing operationstatus
- The StatusServiceOutcome<List<JiraWorkflow>> getAssociatedWorkflows(ApplicationUser user, Status status)
user
- User performing operationstatus
- The StatusServiceResult moveStatusUp(ApplicationUser user, String id)
user
- User performing operaitonid
- Status idServiceResult moveStatusDown(ApplicationUser user, String id)
user
- User performing operaitonid
- Status idboolean isStatusAsLozengeEnabled()
@ExperimentalApi java.util.stream.Stream<Status> findStatuses(@Nonnull String substring, @Nonnull Set<Long> projectIds, @Nonnull Set<String> issueTypeIds)
substring
- the string that status names will be matched withprojectIds
- the set of project ids to filter statusesissueTypeIds
- the set of issue type ids to filter statusesCopyright © 2002-2023 Atlassian. All Rights Reserved.