com.atlassian.fisheye.spi.services

Interface WatchService

public interface WatchService

Provides an api for manipulating repository watches

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addWatch(WatchData watchData) Adds a watch from the attributes of the WatchData instance
java.lang.Iterable<WatchData>	getWatchesForRepo(java.lang.String repoName) Returns watches for the given repository
java.lang.Iterable<WatchData>	getWatchesForUser(java.lang.String userName) Returns watches for the given user
boolean	removeWatch(WatchData watchData) Removes the watch with the attributes of the WatchData instance

Method Detail

getWatchesForUser

java.lang.Iterable<WatchData> getWatchesForUser(java.lang.String userName)
                                                throws java.lang.IllegalArgumentException

Returns watches for the given user

Parameters:

userName - name of the user to get the watches for

Returns:

WatchData for watches for the user

Throws:

java.lang.IllegalArgumentException - if no user with the username exists

getWatchesForRepo

java.lang.Iterable<WatchData> getWatchesForRepo(java.lang.String repoName)

Returns watches for the given repository

Parameters:

repoName - the name of the repository to get the watches for

Returns:

WatchData for watches in the repo

Throws:

java.lang.IllegalArgumentException - if no repository with the repoName exists

addWatch

boolean addWatch(WatchData watchData)
                 throws java.lang.IllegalArgumentException

Adds a watch from the attributes of the WatchData instance

Parameters:

watchData - the WatchData to create the watch from

Returns:

true if a new watch created, false if a watch matching the WatchData already exists

Throws:

java.lang.IllegalArgumentException - when the given WatchData is invalid - contains an illegal repository or user

removeWatch

boolean removeWatch(WatchData watchData)

Removes the watch with the attributes of the WatchData instance

Parameters:

watchData - the WatchData to remove

Returns:

true if a watch was removed, false if no such watch exists