WatchService (Jive Forums API (5.5.8) Developer Javadocs)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jive Forums API (5.5.8) Developer Javadocs

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jivesoftware.forum.webservices
Interface WatchService

All Known Implementing Classes:: WatchServiceImpl

public interface WatchService

A service for manipulating a user's watches on objects.

Field Summary
`static int`	`OBJECT_FORUM` An integer representing Forum Objects
`static int`	`OBJECT_FORUM_CATEGORY` An integer representing Forum Category objects.
`static int`	`OBJECT_THREAD` An integer representing Forum Thread objects.
`static int`	`OBJECT_USER` An integer representing User objects.

Method Summary
`Watch`	`createCategoryWatch(long userID, long categoryID)` Create a watch on a category for the specified user.
`Watch`	`createForumWatch(long userID, long forumID)` Create a watch on a forum for the user with the specified ID.
`Watch`	`createThreadWatch(long userID, long threadID)` Create a watch on a thread for the specified user.
`Watch`	`createUserWatch(long userID, long watchedUserID)` Create a watch on a user for the specified user.
`void`	`deleteWatch(Watch watch)` Delete the specified watch.
`void`	`deleteWatches(long userID)` Deletes all watches that a user has.
`Watch`	`getCategoryWatch(long userID, long categoryID)` Returns a watch on a particular category, or null if there isn't a watch.
`int`	`getCategoryWatchCount(long userID, long categoryID)` Return the count of all forum watches in a particular categoryID for the given userID.
`long[]`	`getCategoryWatches(long userID, long categoryID)` Returns an array of IDs for all the forum objects a user is watching in a category.
`Forum[]`	`getCategoryWatchObjects(long userID, long categoryID, int startIndex, int numResults)` Returns Forums that the user is watching for a given category.
`int`	`getDeleteDays()` Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
`ForumThread[]`	`getForumThreadWatchesByCategory(long userID, long categoryID, int startIndex, int numResults)` Returns ForumThreads that the user is watching for all the Forums under the given Category.
`Watch`	`getForumWatch(long userID, long forumID)` Returns a watch on a particular forum, or null if there isn't a watch.
`int`	`getForumWatchCount(long userID, long forumID)` Return the count of all thread watches in a particular forumID for the given user.
`long[]`	`getForumWatches(long userID, long forumID)` Returns an array of IDs for the threads a user is watching in a forum.
`ForumThread[]`	`getForumWatchObjects(long userID, long forumID, int startIndex, int numResults)` Returns ForumThreads that the user is watching for a given Forum.
`ForumThread[]`	`getRecursiveForumThreadWatchesByCategory(long userID, long categoryID, int startIndex, int numResults)` Returns ForumThreads that the user is watching for all the Forums under the given Category.
`Forum[]`	`getRecursiveForumWatchesByCategory(long userID, long categoryID, int startIndex, int numResults)` Returns Forums that the user is watching for a given category and all of its subcategories.
`Watch`	`getThreadWatch(long userID, long threadID)` Returns a watch on a particular thread, or null if there isn't a watch.
`int`	`getTotalWatchCount(long userID, int objectType)` Returns a count of all watches that a userID has of a particular type.
`Watch`	`getUserWatch(long userID, long watchedUserID)` Returns a watch on a particular user, or null if there isn't a watch.
`User[]`	`getWatchers(int objectType, long objectID)` Returns the Users who are watching the specified object.
`Watch[]`	`getWatchList(long userID, int objectType)` Returns an array of Watch objects for a particular object type that the given user is watching.
`boolean`	`isCategoryWatched(long userID, long categoryID)` Returns true if the user is watching the specified category.
`boolean`	`isForumWatched(long userID, long forumID)` Returns true if the user is watching the specified forum.
`boolean`	`isThreadWatched(long userID, long threadID)` Returns true if the user is watching the specified thread.
`boolean`	`isUserWatched(long userID, long watchedUserID)` Returns true if the user is watching the specified user.
`void`	`setDeleteDays(int deleteDays)` Sets the number of days that a watched object can remain inactive before watches on that object are deleted.

Field Detail

OBJECT_FORUM

static final int OBJECT_FORUM

An integer representing Forum Objects

See Also:: Constant Field Values

OBJECT_THREAD

static final int OBJECT_THREAD

An integer representing Forum Thread objects.

See Also:: Constant Field Values

OBJECT_FORUM_CATEGORY

static final int OBJECT_FORUM_CATEGORY

An integer representing Forum Category objects.

See Also:: Constant Field Values

OBJECT_USER

static final int OBJECT_USER

An integer representing User objects.

See Also:: Constant Field Values

Method Detail

getDeleteDays

int getDeleteDays()

Returns the number of days that a watched object can remain inactive before watches on that object are deleted.

Returns:: the number of days a watched object can be inactive before watches on it are deleted.

setDeleteDays

void setDeleteDays(int deleteDays)

Sets the number of days that a watched object can remain inactive before watches on that object are deleted.

Parameters:: deleteDays - The number days a watch can be inactive before being automatically deleted.

createUserWatch

Watch createUserWatch(long userID,
                      long watchedUserID)
                      throws UserNotFoundException

Create a watch on a user for the specified user.

Parameters:: userID - The ID of the user to set the watch for.; watchedUserID - The ID of the user to watch.
Returns:: The newly created watch.
Throws:: UserNotFoundException

createThreadWatch

Watch createThreadWatch(long userID,
                        long threadID)
                        throws UserNotFoundException,
                               ForumThreadNotFoundException

Create a watch on a thread for the specified user.

Parameters:: userID - The ID of the user to set the watch for.; threadID - The ID of thread to watch.
Returns:: The newly created watch.
Throws:: UserNotFoundException; ForumThreadNotFoundException

createForumWatch

Watch createForumWatch(long userID,
                       long forumID)
                       throws UserNotFoundException,
                              ForumNotFoundException

Create a watch on a forum for the user with the specified ID.

Parameters:: userID - The ID of the user to set a watch for.; forumID - The ID of the forum to watch.
Returns:: The newly created watch.
Throws:: UserNotFoundException; ForumNotFoundException

createCategoryWatch

Watch createCategoryWatch(long userID,
                          long categoryID)
                          throws UserNotFoundException,
                                 ForumCategoryNotFoundException

Create a watch on a category for the specified user.

Parameters:: userID - The ID of the user to set the watch for.; categoryID - The ID of the category to watch.
Returns:: The newly created watch.
Throws:: UserNotFoundException; ForumCategoryNotFoundException

getForumWatchCount

int getForumWatchCount(long userID,
                       long forumID)
                       throws UserNotFoundException,
                              ForumNotFoundException

Return the count of all thread watches in a particular forumID for the given user.

Parameters:: userID - The ID of the user to return the watch count for.; forumID - The ID of the forum to get the watch count for.
Returns:: The count of thread watches for a user in a given forum.
Throws:: UnauthorizedException - if not a system admin or the userID.; UserNotFoundException; ForumNotFoundException

getCategoryWatchCount

int getCategoryWatchCount(long userID,
                          long categoryID)
                          throws UserNotFoundException,
                                 ForumCategoryNotFoundException

Return the count of all forum watches in a particular categoryID for the given userID.

Parameters:: userID - The userID to return the watch count for.; categoryID - The categoryID to return the watch count for.
Returns:: The count of forum watches for a userID in a given categoryID.
Throws:: UnauthorizedException - if not a system admin or the userID.; UserNotFoundException; ForumCategoryNotFoundException

getTotalWatchCount

int getTotalWatchCount(long userID,
                       int objectType)
                       throws UserNotFoundException

Returns a count of all watches that a userID has of a particular type. Valid object types are:

Parameters:: userID - The ID of the user to get the watch count for.; objectType - The object type to get a watch count for.
Returns:: The total number of watches that a userID has of type objectType.
Throws:: UnauthorizedException - if not a system admin or the userID.; UserNotFoundException

getWatchList

Watch[] getWatchList(long userID,
                     int objectType)
                     throws UserNotFoundException

Returns an array of Watch objects for a particular object type that the given user is watching. Valid objectType's are:

Parameters:: userID - the userID to retrieve watches for; objectType - the object type.
Returns:: An array of the user's watches corresponding to an object type.
Throws:: UserNotFoundException

getForumWatches

long[] getForumWatches(long userID,
                       long forumID)
                       throws UserNotFoundException,
                              ForumNotFoundException

Returns an array of IDs for the threads a user is watching in a forum.

Parameters:: userID - The ID of the user.; forumID - The ID of the forum.
Returns:: an array of thread IDs.
Throws:: UserNotFoundException; ForumNotFoundException

getCategoryWatches

long[] getCategoryWatches(long userID,
                          long categoryID)
                          throws UserNotFoundException,
                                 ForumCategoryNotFoundException

Returns an array of IDs for all the forum objects a user is watching in a category.

Parameters:: userID - The ID of the user.; categoryID - The ID of the category.
Returns:: An array of forum IDs.
Throws:: UserNotFoundException; ForumCategoryNotFoundException

getUserWatch

Watch getUserWatch(long userID,
                   long watchedUserID)
                   throws UserNotFoundException

Returns a watch on a particular user, or null if there isn't a watch.

Parameters:: userID - the userID with the watch.; watchedUserID - the userID being watched.
Returns:: the Watch or null if the watchedUserID isn't being watched by the userID.
Throws:: UserNotFoundException

getThreadWatch

Watch getThreadWatch(long userID,
                     long threadID)
                     throws UserNotFoundException,
                            ForumThreadNotFoundException

Returns a watch on a particular thread, or null if there isn't a watch.

Parameters:: userID - The ID of the user with the watch.; threadID - The ID of the thread being watched.
Returns:: The Watch or null if the thread isn't being watched by the user.
Throws:: UserNotFoundException; ForumThreadNotFoundException

getForumWatch

Watch getForumWatch(long userID,
                    long forumID)
                    throws UserNotFoundException,
                           ForumNotFoundException

Returns a watch on a particular forum, or null if there isn't a watch.

Parameters:: userID - The ID of the user.; forumID - The ID of the forum.
Returns:: The Watch or null if the forum isn't being watched by the user.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException; ForumNotFoundException

getCategoryWatch

Watch getCategoryWatch(long userID,
                       long categoryID)
                       throws UserNotFoundException,
                              ForumCategoryNotFoundException

Returns a watch on a particular category, or null if there isn't a watch.

Parameters:: userID - The ID of the user to acquire a watch for.; categoryID - The ID of the category to acquire the watch for.
Returns:: The Watch or null if the category isn't being watched by the user.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException; ForumCategoryNotFoundException

isCategoryWatched

boolean isCategoryWatched(long userID,
                          long categoryID)
                          throws UserNotFoundException,
                                 ForumCategoryNotFoundException

Returns true if the user is watching the specified category.

Parameters:: userID - The ID of the user.; categoryID - The ID of the category.
Returns:: True if the object is being watched by the user, false otherwise.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException; ForumCategoryNotFoundException

isForumWatched

boolean isForumWatched(long userID,
                       long forumID)
                       throws UserNotFoundException,
                              ForumNotFoundException

Returns true if the user is watching the specified forum.

Parameters:: userID - The ID of the user.; forumID - The ID of the forum.
Returns:: True if the object is being watched by the user, false otherwise.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException; ForumNotFoundException

isThreadWatched

boolean isThreadWatched(long userID,
                        long threadID)
                        throws UserNotFoundException,
                               ForumThreadNotFoundException

Returns true if the user is watching the specified thread.

Parameters:: userID - The ID of the user.; threadID - The ID of the thread.
Returns:: True if the object is being watched by the user, false otherwise.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException; ForumThreadNotFoundException

isUserWatched

boolean isUserWatched(long userID,
                      long watchedUserID)
                      throws UserNotFoundException

Returns true if the user is watching the specified user.

Parameters:: userID - The ID of the user.; watchedUserID - The ID of the watched user.
Returns:: True if the object is being watched by the user, false otherwise.
Throws:: UnauthorizedException - if not a system admin or the user.; UserNotFoundException

deleteWatch

void deleteWatch(Watch watch)
                 throws UserNotFoundException,
                        ForumNotFoundException,
                        ForumCategoryNotFoundException,
                        ForumThreadNotFoundException

Delete the specified watch.

Parameters:: watch - The watch to delete.
Throws:: UnauthorizedException - if not a system admin or the user owning the watch.; UserNotFoundException; ForumNotFoundException; ForumCategoryNotFoundException; ForumThreadNotFoundException

deleteWatches

void deleteWatches(long userID)
                   throws UserNotFoundException

Deletes all watches that a user has.

Parameters:: userID - The ID of the user.
Throws:: UnauthorizedException - if not a system admin or the user owning the watch.; UserNotFoundException

getWatchers

User[] getWatchers(int objectType,
                   long objectID)

Returns the Users who are watching the specified object.

Parameters:: objectType - the object type.; objectID - the object ID
Returns:: the users watching the specified object.

getForumWatchObjects

ForumThread[] getForumWatchObjects(long userID,
                                   long forumID,
                                   int startIndex,
                                   int numResults)
                                   throws UserNotFoundException,
                                          ForumNotFoundException

Returns ForumThreads that the user is watching for a given Forum. This also allows the users to define the offset and number of records returned. Enter 0 for startIndex and Integer.MAX_VALUE to return all results

Parameters:: userID - The ID of the user.; forumID - The ID of the forum.; startIndex - The offset.; numResults - The max number of results returned.
Returns:: Array of ForumThread objects meeting the criteria.
Throws:: UserNotFoundException; ForumNotFoundException

getCategoryWatchObjects

Forum[] getCategoryWatchObjects(long userID,
                                long categoryID,
                                int startIndex,
                                int numResults)
                                throws UserNotFoundException,
                                       ForumCategoryNotFoundException

Returns Forums that the user is watching for a given category. This also allows the users to define the offset and number of records returned. Enter 0 for startIndex and Integer.MAX_VALUE to return all results.

For recursive Forum watches for a given category, use getRecursiveForumWatchesByCategory.

Parameters:: userID - The ID of the user.; categoryID - The ID of the category.; startIndex - The offset.; numResults - The max number of results returned.
Returns:: Array of Forums meeting the criteria.
Throws:: UserNotFoundException; ForumCategoryNotFoundException

getForumThreadWatchesByCategory

ForumThread[] getForumThreadWatchesByCategory(long userID,
                                              long categoryID,
                                              int startIndex,
                                              int numResults)
                                              throws UserNotFoundException,
                                                     ForumCategoryNotFoundException

Returns ForumThreads that the user is watching for all the Forums under the given Category. Does not recurse through subcategories.

Specify 0 for startIndex and Integer.MAX_VALUE to return all results.

Parameters:: userID - The ID of the user.; categoryID - The ID of the category.; startIndex - The offset.; numResults - The max number of results returned.
Returns:: Array of ForumThread objects meeting the criteria.
Throws:: UserNotFoundException; ForumCategoryNotFoundException

getRecursiveForumThreadWatchesByCategory

ForumThread[] getRecursiveForumThreadWatchesByCategory(long userID,
                                                       long categoryID,
                                                       int startIndex,
                                                       int numResults)
                                                       throws UserNotFoundException,
                                                              ForumCategoryNotFoundException