Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Interface WatchManager

All Known Implementing Classes:
DbWatchManager, WatchManagerProxy

public interface WatchManager

Manages watches on categories, forums, and threads. A watch is a way for a user to track updates to an object. Users add watches on individual objects and can specify whether or not they want to be notified by email each time the object is updated.

Because the number of watches could build up and overload the system over time, watches are automatically deleted after the objects they are attached to are inactive for a certain number of days or if the object expires. Individual watches can be toggled to be undeletable so that it is possible to circumvent this behavior.


Method Summary
 Watch createWatch(User user, Forum forum)
          Create a watch on a forum for the specified user.
 Watch createWatch(User user, ForumCategory category)
          Create a watch on a category for the specified user.
 Watch createWatch(User user, ForumThread thread)
          Create a watch on a thread for the specified user.
 Watch createWatch(User user, User watchedUser)
          Create a watch on a user for the specified user.
 void deleteWatch(Watch watch)
          Delete the specified watch.
 void deleteWatches(User user)
          Deletes all watches that a user has.
 java.util.Iterator getAllWatches(User user, int objectType)
          Returns an iterator for all objects of a particular type that a user is watching.
 int getDeleteDays()
          Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
 int getRecursiveForumWatchCount(User user, ForumCategory category)
          Returns number of Forum objects the user is watching under the category and its subcategories.
 java.util.Iterator getRecursiveForumWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns all the Forum objects the user is watching under the category and its subcategories.
 int getRecursiveThreadWatchCount(User user, ForumCategory category)
          Returns the number of ForumThread objects the user is watching under the provided ForumCategory.
 java.util.Iterator getRecursiveThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 java.util.Iterator getThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 int getTotalWatchCount(User user, int objectType)
          Returns a count of all watches that a user has of a particular type.
 Watch getWatch(User user, Forum forum)
          Returns a watch on a particular forum, or null if there isn't a watch.
 Watch getWatch(User user, ForumCategory category)
          Returns a watch on a particular category, or null if there isn't a watch.
 Watch getWatch(User user, ForumThread thread)
          Returns a watch on a particular thread, or null if there isn't a watch.
 Watch getWatch(User user, User watchedUser)
          Returns a watch on a particular thread, or null if there isn't a watch.
 int getWatchCount(User user, Forum forum)
          Return the count of all thread watches in a particular forum for the given user.
 int getWatchCount(User user, ForumCategory category)
          Return the count of all forum watches in a particular category for the given user.
 java.util.Iterator getWatchers(int objectType, long objectID)
          Returns all the Users watching the specified object.
 java.util.Iterator getWatches(User user, Forum forum)
          Returns an Iterator for all the thread objects a user is watching in a forum.
 java.util.Iterator getWatches(User user, ForumCategory category)
          Returns an Iterator for all the forum objects a user is watching in a category.
 java.util.Iterator getWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the Forums watched by the User under the given Category.
 java.util.Iterator getWatches(User user, Forum forum, int startIndex, int numResults)
          Returns all the ForumThreads watched by the User under the given Forum.
 Watch[] getWatchList(User user, int objectType)
          Returns an array of Watch objects for a particular object type that the given user is watching.
 boolean isWatched(User user, Forum forum)
          Returns true if the user is watching the specified forum.
 boolean isWatched(User user, ForumCategory category)
          Returns true if the user is watching the specified category.
 boolean isWatched(User user, ForumThread thread)
          Returns true if the user is watching the specified thread.
 boolean isWatched(User user, User watchedUser)
          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.
 

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)
                   throws UnauthorizedException
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.
Throws:
UnauthorizedException - if not a system admin.

createWatch

Watch createWatch(User user,
                  User watchedUser)
                  throws UnauthorizedException
Create a watch on a user for the specified user.

Parameters:
user - the user to set the watch for.
watchedUser - the user to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

Watch createWatch(User user,
                  ForumThread thread)
                  throws UnauthorizedException
Create a watch on a thread for the specified user.

Parameters:
user - the user to set the watch for.
thread - the thread to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

Watch createWatch(User user,
                  Forum forum)
                  throws UnauthorizedException
Create a watch on a forum for the specified user.

Parameters:
user - the user to set the watch for.
forum - the forum to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

createWatch

Watch createWatch(User user,
                  ForumCategory category)
                  throws UnauthorizedException
Create a watch on a category for the specified user.

Parameters:
user - the user to set the watch for.
category - the category to watch.
Returns:
the created watch.
Throws:
UnauthorizedException - if not an admin or the user.

getWatchCount

int getWatchCount(User user,
                  Forum forum)
                  throws UnauthorizedException
Return the count of all thread watches in a particular forum for the given user.

Parameters:
user - the user to return 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 user.

getWatchCount

int getWatchCount(User user,
                  ForumCategory category)
                  throws UnauthorizedException
Return the count of all forum watches in a particular category for the given user.

Parameters:
user - the user to return the watch count for.
category - the category to return the watch count for.
Returns:
the count of forum watches for a user in a given category.
Throws:
UnauthorizedException - if not a system admin or the user.

getTotalWatchCount

int getTotalWatchCount(User user,
                       int objectType)
                       throws UnauthorizedException
Returns a count of all watches that a user has of a particular type. Valid object types are:

Parameters:
user - 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 user has of type objectType.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatchList

Watch[] getWatchList(User user,
                     int objectType)
Returns an array of Watch objects for a particular object type that the given user is watching. Valid objectType's are:

Parameters:
user - the user to retrieve watches for
objectType - the object type.
Returns:
the user's watch list corresponding to an object type.

getAllWatches

java.util.Iterator getAllWatches(User user,
                                 int objectType)
                                 throws UnauthorizedException
Returns an iterator for all objects of a particular type that a user is watching. Valid objecttypes are:

Parameters:
user - the user.
objectType - the object type.
Returns:
an iterator for all objects of type objectType that a user is watching.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatches

java.util.Iterator getWatches(User user,
                              Forum forum)
                              throws UnauthorizedException
Returns an Iterator for all the thread objects a user is watching in a forum.

Parameters:
user - the user.
forum - the forum.
Returns:
an iterator for all the threads a user is watching in a forum.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatches

java.util.Iterator getWatches(User user,
                              ForumCategory category)
                              throws UnauthorizedException
Returns an Iterator for all the forum objects a user is watching in a category.

Parameters:
user - the user.
category - the category.
Returns:
an iterator for all the forums a user is watching in a category.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

Watch getWatch(User user,
               User watchedUser)
               throws UnauthorizedException
Returns a watch on a particular thread, or null if there isn't a watch.

Parameters:
user - the user with the watch.
watchedUser - the user being watched.
Returns:
the Watch or null if the watchedUser isn't being watched by the user.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

Watch getWatch(User user,
               ForumThread thread)
               throws UnauthorizedException
Returns a watch on a particular thread, or null if there isn't a watch.

Parameters:
user - the user with the watch.
thread - the thread being watched.
Returns:
the Watch or null if the thread isn't being watched by the user.
Throws:
UnauthorizedException - if not a system admin or the user.

getWatch

Watch getWatch(User user,
               Forum forum)
               throws UnauthorizedException
Returns a watch on a particular forum, or null if there isn't a watch.

Parameters:
user - the user with the watch.
forum - the forum being watched.
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.

getWatch

Watch getWatch(User user,
               ForumCategory category)
               throws UnauthorizedException
Returns a watch on a particular category, or null if there isn't a watch.

Parameters:
user - the user with the watch.
category - the category being watched.
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.

isWatched

boolean isWatched(User user,
                  ForumCategory category)
                  throws UnauthorizedException
Returns true if the user is watching the specified category.

Parameters:
user - the User watching the object.
category - the category to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

boolean isWatched(User user,
                  Forum forum)
                  throws UnauthorizedException
Returns true if the user is watching the specified forum.

Parameters:
user - the User watching the object.
forum - the forum to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

boolean isWatched(User user,
                  ForumThread thread)
                  throws UnauthorizedException
Returns true if the user is watching the specified thread.

Parameters:
user - the User watching the object.
thread - the thread to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

isWatched

boolean isWatched(User user,
                  User watchedUser)
                  throws UnauthorizedException
Returns true if the user is watching the specified user.

Parameters:
user - the User watching the object.
watchedUser - the user to check.
Returns:
true if the object is being watched by the user, false otherwise.
Throws:
UnauthorizedException - if not a system admin or the user.

deleteWatch

void deleteWatch(Watch watch)
                 throws UnauthorizedException
Delete the specified watch.

Parameters:
watch - the watch to delete.
Throws:
UnauthorizedException - if not a system admin or the user owning the watch.

deleteWatches

void deleteWatches(User user)
                   throws UnauthorizedException
Deletes all watches that a user has.

Parameters:
user - the user.
Throws:
UnauthorizedException

getWatchers

java.util.Iterator getWatchers(int objectType,
                               long objectID)
                               throws UnauthorizedException
Returns all the Users watching the specified object.

Parameters:
objectID - the ID of the object.
objectType - the type of the object from JiveConstants.
Returns:
Iterator of Users.
Throws:
UnauthorizedException - if not a system admin

getWatches

java.util.Iterator getWatches(User user,
                              Forum forum,
                              int startIndex,
                              int numResults)
Returns all the ForumThreads watched by the User under the given Forum.

Parameters:
user - the user.
forum - the forum to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by the user.

getWatches

java.util.Iterator getWatches(User user,
                              ForumCategory category,
                              int startIndex,
                              int numResults)
Returns the Forums watched by the User under the given Category. This method does not recurse SubCategories. For recursive watches, use getRecursiveForumWatches.

Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return
Returns:
the Forum objects watched by the user.

getRecursiveForumWatches

java.util.Iterator getRecursiveForumWatches(User user,
                                            ForumCategory category,
                                            int startIndex,
                                            int numResults)
Returns all the Forum objects the user is watching under the category and its subcategories. Recurses on subcategories.

Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the Forum objects watched by this user.

getRecursiveForumWatchCount

int getRecursiveForumWatchCount(User user,
                                ForumCategory category)
Returns number of Forum objects the user is watching under the category and its subcategories. Recurses on subcategories.

Parameters:
user - the user.
category - the category to begin looking for watches.
Returns:
the number of Forum objects watched by this user.

getThreadWatches

java.util.Iterator getThreadWatches(User user,
                                    ForumCategory category,
                                    int startIndex,
                                    int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. Does not recurse to subcategories, only the Forums directly in the provided ForumCategory.

Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by this user.

getRecursiveThreadWatches

java.util.Iterator getRecursiveThreadWatches(User user,
                                             ForumCategory category,
                                             int startIndex,
                                             int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. Recurses through Subcategories and Forums.

Parameters:
user - the user.
category - the category to begin looking for watches.
startIndex - the start index.
numResults - the number of results to return.
Returns:
the ForumThread objects watched by this user.

getRecursiveThreadWatchCount

int getRecursiveThreadWatchCount(User user,
                                 ForumCategory category)
Returns the number of ForumThread objects the user is watching under the provided ForumCategory. Recurses through Subcategories and Forums.

Parameters:
user - the user.
category - the category to begin looking for watches.
Returns:
the number of ForumThread objects watched by this user.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.