com.nulabinc.backlog4j.api

Interface StatusMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface StatusMethods

Executes Backlog Status APIs.

Method Summary

Modifier and Type	Method and Description
Status	addStatus(AddStatusParams params) Add status in the project.
ResponseList<Status>	getStatuses() Returns the statuses.
Status	removeStatus(java.lang.Object projectIdOrKey, java.lang.Object statusId, java.lang.Object substituteStatusId) Removes the status in the project.
ResponseList<Status>	updateOrderOfStatus(UpdateOrderOfStatusParams params) Updates the statuses order in the project.
Status	updateStatus(UpdateStatusParams params) Updates the existing status in the project.

Method Detail

getStatuses

ResponseList<Status> getStatuses()
                          throws BacklogException

Returns the statuses.

Returns:

the statuses in a list

Throws:

BacklogException

addStatus

Status addStatus(AddStatusParams params)
          throws BacklogException

Add status in the project.

Parameters:

params - the adding status parameters.

Returns:

the added status

Throws:

BacklogException

updateStatus

Status updateStatus(UpdateStatusParams params)
             throws BacklogException

Updates the existing status in the project.

Parameters:

params - the updating status parameters.

Returns:

the updated status

Throws:

BacklogException

updateOrderOfStatus

ResponseList<Status> updateOrderOfStatus(UpdateOrderOfStatusParams params)
                                  throws BacklogException

Updates the statuses order in the project.

Parameters:

params - the updating statuses order parameters.

Returns:

the updated statuses

Throws:

BacklogException

removeStatus

Status removeStatus(java.lang.Object projectIdOrKey,
                    java.lang.Object statusId,
                    java.lang.Object substituteStatusId)
             throws BacklogException

Removes the status in the project.

Parameters:

projectIdOrKey - the project identifier

statusId - the status identifier

substituteStatusId - the substitute status identifier

Returns:

the removed status

Throws:

BacklogException