|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface StatusService
This class contains methods for managing Status
es with validation
Field Summary | |
---|---|
static int |
MAX_STATUS_LENGTH
Maximum length allowed for the name of a status. |
Method Summary | |
---|---|
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 |
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 |
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 |
Field Detail |
---|
static final int MAX_STATUS_LENGTH
Method Detail |
---|
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 null
validateCreateStatus(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 null
ServiceOutcome<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 null
validateEditStatus(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 null
Status getStatusById(ApplicationUser user, String id)
user
- User performing operationid
- status id
Status
, or null if no status with this id exists.ServiceResult removeStatus(ApplicationUser user, Status status)
user
- User performing operationstatus
- Status
ServiceResult validateRemoveStatus(ApplicationUser user, Status status)
user
- User performing operationstatus
- The Status
ServiceOutcome<List<JiraWorkflow>> getAssociatedWorkflows(ApplicationUser user, Status status)
user
- User performing operationstatus
- The Status
boolean isStatusAsLozengeEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |