com.atlassian.bitbucket.watcher

Class WatcherSearchRequest

java.lang.Object

com.atlassian.bitbucket.watcher.WatcherSearchRequest

public class WatcherSearchRequest
extends Object

A request object to search for watcher entities by watchable. To check if a watcher exists for a given user / watchable pair see IsWatchingRequest

Since:

5.10

See Also:

WatcherService.search(WatcherSearchRequest, com.atlassian.bitbucket.util.PageRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WatcherSearchRequest.Builder

Method Summary

Modifier and Type	Method and Description
Watchable	getWatchable()
boolean	isTransitive() Indicates if a transitive search should be performed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getWatchable

@Nonnull
public Watchable getWatchable()

isTransitive

public boolean isTransitive()

Indicates if a transitive search should be performed.

Transitive searches will retrieve watchers within a hierarchy. Users who are watching multiple entities in a hierarchy will be de-duplicated and only the most specific entity in the hierarchy will be returned. For example, if a user is watching a repository and a pull request only the pull request watcher will be returned.

Returns:

true if a transitive search should be performed. false otherwise