com.nulabinc.backlog4j.api.WatchingMethods 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.

There is a newer version: 2.6.0

package com.nulabinc.backlog4j.api;

import com.nulabinc.backlog4j.BacklogException;
import com.nulabinc.backlog4j.Watch;
import com.nulabinc.backlog4j.api.option.UpdateWatchParams;

/**
 * Executes Backlog Watch APIs.
 */
public interface WatchingMethods {

    /**
     * Returns the Watch.
     *
     * @param watchingId
     * @return the Watch
     * @throws BacklogException
     */
    Watch getWatch(Long watchingId) throws BacklogException;

    /**
     * Adds a watching to the issue.
     *
     * @param watchingId the issue identifier
     * @param note
     * @throws BacklogException
     */
    Watch addWatchToIssue(Object watchingId, String note) throws BacklogException;

    /**
     * Updates the existing watching.
     *
     * @param params the updating project parameters
     * @return the updated Watching
     * @throws BacklogException
     */
    Watch updateWatch(UpdateWatchParams params) throws BacklogException;

    /**
     * Deletes the existing watching.
     *
     * @param watchingId the watching identifier
     * @return the deleted watching
     * @throws BacklogException
     */
    Watch deleteWatch(Object watchingId) throws BacklogException;

    /**
     * Marks the watching as already read.
     *
     * @param numericUserId the user identifier
     * @throws BacklogException
     */
    void markAsCheckedUserWatches(Object numericUserId) throws BacklogException;

}