|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.proxy.WatchManagerProxy
public class WatchManagerProxy
A protection proxy for the WatchManager class. A proxy has a set of permissions that are specified at creation time of the proxy. Subsequently, those permissions are use to restrict access to protected methods. If a user does not have the right to execute a particular method, an UnauthorizedException is thrown.
Permissions
,
UnauthorizedException
Constructor Summary | |
---|---|
WatchManagerProxy(WatchManager manager,
AuthToken authToken,
Permissions permissions)
Creates a new WatchManagerProxy object. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WatchManagerProxy(WatchManager manager, AuthToken authToken, Permissions permissions)
manager
- the watchmanager to protect by proxy.authToken
- the user's authorization token.permissions
- the permissions to use with this proxy.Method Detail |
---|
public void setDeleteDays(int deleteDays) throws UnauthorizedException
WatchManager
setDeleteDays
in interface WatchManager
deleteDays
- the number days a watch can be inactive before being
automatically deleted.
UnauthorizedException
- if not a system admin.public int getDeleteDays()
WatchManager
getDeleteDays
in interface WatchManager
public Watch createWatch(User user, User watchedUser) throws UnauthorizedException
WatchManager
createWatch
in interface WatchManager
user
- the user to set the watch for.watchedUser
- the user to watch.
UnauthorizedException
- if not an admin or the user.public Watch createWatch(User user, ForumThread thread) throws UnauthorizedException
WatchManager
createWatch
in interface WatchManager
user
- the user to set the watch for.thread
- the thread to watch.
UnauthorizedException
- if not an admin or the user.public Watch createWatch(User user, Forum forum) throws UnauthorizedException
WatchManager
createWatch
in interface WatchManager
user
- the user to set the watch for.forum
- the forum to watch.
UnauthorizedException
- if not an admin or the user.public Watch createWatch(User user, ForumCategory category) throws UnauthorizedException
WatchManager
createWatch
in interface WatchManager
user
- the user to set the watch for.category
- the category to watch.
UnauthorizedException
- if not an admin or the user.public int getTotalWatchCount(User user, int objectType) throws UnauthorizedException
WatchManager
getTotalWatchCount
in interface WatchManager
user
- the user to get the watch count for.objectType
- the object type to get a watch count for.
UnauthorizedException
- if not a system admin or the user.public Watch[] getWatchList(User user, int objectType)
WatchManager
getWatchList
in interface WatchManager
user
- the user to retrieve watches forobjectType
- the object type.
public java.util.Iterator getAllWatches(User user, int objectType) throws UnauthorizedException
WatchManager
getAllWatches
in interface WatchManager
user
- the user.objectType
- the object type.
UnauthorizedException
- if not a system admin or the user.public int getWatchCount(User user, Forum forum) throws UnauthorizedException
WatchManager
getWatchCount
in interface WatchManager
user
- the user to return the watch count for.
UnauthorizedException
- if not a system admin or the user.public int getWatchCount(User user, ForumCategory category) throws UnauthorizedException
WatchManager
getWatchCount
in interface WatchManager
user
- the user to return the watch count for.category
- the category to return the watch count for.
UnauthorizedException
- if not a system admin or the user.public java.util.Iterator getWatches(User user, Forum forum) throws UnauthorizedException
WatchManager
getWatches
in interface WatchManager
user
- the user.forum
- the forum.
UnauthorizedException
- if not a system admin or the user.public java.util.Iterator getWatches(User user, ForumCategory category) throws UnauthorizedException
WatchManager
getWatches
in interface WatchManager
user
- the user.category
- the category.
UnauthorizedException
- if not a system admin or the user.public Watch getWatch(User user, User watchedUser) throws UnauthorizedException
WatchManager
getWatch
in interface WatchManager
user
- the user with the watch.watchedUser
- the user being watched.
UnauthorizedException
- if not a system admin or the user.public Watch getWatch(User user, ForumThread thread) throws UnauthorizedException
WatchManager
getWatch
in interface WatchManager
user
- the user with the watch.thread
- the thread being watched.
UnauthorizedException
- if not a system admin or the user.public Watch getWatch(User user, Forum forum) throws UnauthorizedException
WatchManager
getWatch
in interface WatchManager
user
- the user with the watch.forum
- the forum being watched.
UnauthorizedException
- if not a system admin or the user.public Watch getWatch(User user, ForumCategory category) throws UnauthorizedException
WatchManager
getWatch
in interface WatchManager
user
- the user with the watch.category
- the category being watched.
UnauthorizedException
- if not a system admin or the user.public boolean isWatched(User user, ForumCategory category) throws UnauthorizedException
WatchManager
isWatched
in interface WatchManager
user
- the User watching the object.category
- the category to check.
UnauthorizedException
- if not a system admin or the user.public boolean isWatched(User user, Forum forum) throws UnauthorizedException
WatchManager
isWatched
in interface WatchManager
user
- the User watching the object.forum
- the forum to check.
UnauthorizedException
- if not a system admin or the user.public boolean isWatched(User user, ForumThread thread) throws UnauthorizedException
WatchManager
isWatched
in interface WatchManager
user
- the User watching the object.thread
- the thread to check.
UnauthorizedException
- if not a system admin or the user.public boolean isWatched(User user, User watchedUser) throws UnauthorizedException
WatchManager
isWatched
in interface WatchManager
user
- the User watching the object.watchedUser
- the user to check.
UnauthorizedException
- if not a system admin or the user.public void deleteWatches(User user) throws UnauthorizedException
WatchManager
deleteWatches
in interface WatchManager
user
- the user.
UnauthorizedException
public void deleteWatch(Watch watch) throws UnauthorizedException
WatchManager
deleteWatch
in interface WatchManager
watch
- the watch to delete.
UnauthorizedException
- if not a system admin or the user owning the watch.public java.util.Iterator getWatchers(int objectType, long objectID) throws UnauthorizedException
WatchManager
getWatchers
in interface WatchManager
objectType
- the type of the object from JiveConstants.objectID
- the ID of the object.
UnauthorizedException
- if not a system adminpublic java.util.Iterator getWatches(User user, Forum forum, int startIndex, int numResults)
WatchManager
getWatches
in interface WatchManager
user
- the user.forum
- the forum to begin looking for watches.startIndex
- the start index.numResults
- the number of results to return.
public java.util.Iterator getWatches(User user, ForumCategory category, int startIndex, int numResults)
WatchManager
getWatches
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.startIndex
- the start index.numResults
- the number of results to return
public java.util.Iterator getRecursiveForumWatches(User user, ForumCategory category, int startIndex, int numResults)
WatchManager
getRecursiveForumWatches
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.startIndex
- the start index.numResults
- the number of results to return.
public int getRecursiveForumWatchCount(User user, ForumCategory category)
WatchManager
getRecursiveForumWatchCount
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.
public java.util.Iterator getThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
WatchManager
getThreadWatches
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.startIndex
- the start index.numResults
- the number of results to return.
public java.util.Iterator getRecursiveThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
WatchManager
getRecursiveThreadWatches
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.startIndex
- the start index.numResults
- the number of results to return.
public int getRecursiveThreadWatchCount(User user, ForumCategory category)
WatchManager
getRecursiveThreadWatchCount
in interface WatchManager
user
- the user.category
- the category to begin looking for watches.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |