com.nulabinc.backlog4j.api.StatusMethods Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of backlog4j Show documentation

Backlog4j is a Backlog binding library for Java.

The newest version!

package com.nulabinc.backlog4j.api;

import com.nulabinc.backlog4j.BacklogException;
import com.nulabinc.backlog4j.ResponseList;
import com.nulabinc.backlog4j.Status;
import com.nulabinc.backlog4j.api.option.AddStatusParams;
import com.nulabinc.backlog4j.api.option.UpdateOrderOfStatusParams;
import com.nulabinc.backlog4j.api.option.UpdateStatusParams;

/**
 * Executes Backlog Status APIs.
 *
 * @author nulab-inc
 */
public interface StatusMethods {

    /**
     * Returns the statuses.
     *
     * @return the statuses in a list
     * @throws BacklogException
     */
    ResponseList getStatuses() throws BacklogException;

    /**
     * Add status in the project.
     *
     * @param params the adding status parameters.
     * @return the added status
     * @throws BacklogException
     */
    Status addStatus(AddStatusParams params) throws BacklogException;

    /**
     * Updates the existing status in the project.
     *
     * @param params the updating status parameters.
     * @return the updated status
     * @throws BacklogException
     */
    Status updateStatus(UpdateStatusParams params) throws BacklogException;

    /**
     * Updates the statuses order in the project.
     *
     * @param params the updating statuses order parameters.
     * @return the updated statuses
     * @throws BacklogException
     */
    ResponseList updateOrderOfStatus(UpdateOrderOfStatusParams params) throws BacklogException;

    /**
     * Removes the status in the project.
     *
     * @param projectIdOrKey     the project identifier
     * @param statusId           the status identifier
     * @param substituteStatusId the substitute status identifier
     * @return the removed status
     * @throws BacklogException
     */
    Status removeStatus(Object projectIdOrKey, Object statusId, Object substituteStatusId) throws BacklogException;
}