|
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 |
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. |
int |
getRecursiveForumThreadWatchCountByCategory(long userID,
long categoryID)
Return the count of all thread watches in a particular categoryID for the given user. |
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. |
int |
getRecursiveForumWatchCountByCategory(long userID,
long categoryID)
Return the count of all forum watches in a particular categoryID for the given userID. |
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 |
---|
static final int OBJECT_FORUM
static final int OBJECT_THREAD
static final int OBJECT_FORUM_CATEGORY
static final int OBJECT_USER
Method Detail |
---|
int getDeleteDays()
void setDeleteDays(int deleteDays)
deleteDays
- The number days a watch can be inactive before being
automatically deleted.Watch createUserWatch(long userID, long watchedUserID) throws UserNotFoundException
userID
- The ID of the user to set the watch for.watchedUserID
- The ID of the user to watch.
UserNotFoundException
Watch createThreadWatch(long userID, long threadID) throws UserNotFoundException, ForumThreadNotFoundException
userID
- The ID of the user to set the watch for.threadID
- The ID of thread to watch.
UserNotFoundException
ForumThreadNotFoundException
Watch createForumWatch(long userID, long forumID) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user to set a watch for.forumID
- The ID of the forum to watch.
UserNotFoundException
ForumNotFoundException
Watch createCategoryWatch(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user to set the watch for.categoryID
- The ID of the category to watch.
UserNotFoundException
ForumCategoryNotFoundException
int getForumWatchCount(long userID, long forumID) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user to return the watch count for.forumID
- The ID of the forum to get the watch count for.
UnauthorizedException
- if not a system admin or the userID.
UserNotFoundException
ForumNotFoundException
int getCategoryWatchCount(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The userID to return the watch count for.categoryID
- The categoryID to return the watch count for.
UnauthorizedException
- if not a system admin or the userID.
UserNotFoundException
ForumCategoryNotFoundException
int getTotalWatchCount(long userID, int objectType) throws UserNotFoundException
userID
- The ID of 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 userID.
UserNotFoundException
Watch[] getWatchList(long userID, int objectType) throws UserNotFoundException
userID
- the userID to retrieve watches forobjectType
- the object type.
UserNotFoundException
long[] getForumWatches(long userID, long forumID) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user.forumID
- The ID of the forum.
UserNotFoundException
ForumNotFoundException
long[] getCategoryWatches(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.
UserNotFoundException
ForumCategoryNotFoundException
Watch getUserWatch(long userID, long watchedUserID) throws UserNotFoundException
userID
- the userID with the watch.watchedUserID
- the userID being watched.
UserNotFoundException
Watch getThreadWatch(long userID, long threadID) throws UserNotFoundException, ForumThreadNotFoundException
userID
- The ID of the user with the watch.threadID
- The ID of the thread being watched.
UserNotFoundException
ForumThreadNotFoundException
Watch getForumWatch(long userID, long forumID) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user.forumID
- The ID of the forum.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
ForumNotFoundException
Watch getCategoryWatch(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user to acquire a watch for.categoryID
- The ID of the category to acquire the watch for.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
ForumCategoryNotFoundException
boolean isCategoryWatched(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
ForumCategoryNotFoundException
boolean isForumWatched(long userID, long forumID) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user.forumID
- The ID of the forum.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
ForumNotFoundException
boolean isThreadWatched(long userID, long threadID) throws UserNotFoundException, ForumThreadNotFoundException
userID
- The ID of the user.threadID
- The ID of the thread.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
ForumThreadNotFoundException
boolean isUserWatched(long userID, long watchedUserID) throws UserNotFoundException
userID
- The ID of the user.watchedUserID
- The ID of the watched user.
UnauthorizedException
- if not a system admin or the user.
UserNotFoundException
void deleteWatch(Watch watch) throws UserNotFoundException, ForumNotFoundException, ForumCategoryNotFoundException, ForumThreadNotFoundException
watch
- The watch to delete.
UnauthorizedException
- if not a system admin or the user owning the watch.
UserNotFoundException
ForumNotFoundException
ForumCategoryNotFoundException
ForumThreadNotFoundException
void deleteWatches(long userID) throws UserNotFoundException
userID
- The ID of the user.
UnauthorizedException
- if not a system admin or the user owning the watch.
UserNotFoundException
User[] getWatchers(int objectType, long objectID)
objectType
- the object type.objectID
- the object ID
ForumThread[] getForumWatchObjects(long userID, long forumID, int startIndex, int numResults) throws UserNotFoundException, ForumNotFoundException
userID
- The ID of the user.forumID
- The ID of the forum.startIndex
- The offset.numResults
- The max number of results returned.
UserNotFoundException
ForumNotFoundException
Forum[] getCategoryWatchObjects(long userID, long categoryID, int startIndex, int numResults) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.startIndex
- The offset.numResults
- The max number of results returned.
UserNotFoundException
ForumCategoryNotFoundException
ForumThread[] getForumThreadWatchesByCategory(long userID, long categoryID, int startIndex, int numResults) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.startIndex
- The offset.numResults
- The max number of results returned.
UserNotFoundException
ForumCategoryNotFoundException
ForumThread[] getRecursiveForumThreadWatchesByCategory(long userID, long categoryID, int startIndex, int numResults) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.startIndex
- The offset.numResults
- The max number of results returned.
UserNotFoundException
ForumCategoryNotFoundException
Forum[] getRecursiveForumWatchesByCategory(long userID, long categoryID, int startIndex, int numResults) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user.categoryID
- The ID of the category.startIndex
- The offset.numResults
- The max number of results returned.
UserNotFoundException
ForumCategoryNotFoundException
int getRecursiveForumThreadWatchCountByCategory(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user to return the watch count for.categoryID
- The ID of the category.
UserNotFoundException
ForumCategoryNotFoundException
int getRecursiveForumWatchCountByCategory(long userID, long categoryID) throws UserNotFoundException, ForumCategoryNotFoundException
userID
- The ID of the user to return the watch count for.categoryID
- The ID of the category.
UserNotFoundException
ForumCategoryNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |