|
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.stats.ViewCountManager
public class ViewCountManager
A class to handle saving and retrieving view counts for various Jive Forums objects.
Method Summary | |
---|---|
void |
addCategoryCount(ForumCategory category)
Increments the view count of the given category by 1 or does nothing if view counts are not enabled. |
void |
addForumCount(Forum forum)
Increments the view count of the given forum by 1 or does nothing if view counts are not enabled. |
void |
addThreadCount(ForumThread thread)
Increments the view count of the given thread by 1 or does nothing if view counts are not enabled. |
void |
categoryAdded(CategoryEvent event)
From the CategoryListener interface. |
void |
categoryDeleted(CategoryEvent event)
From the CategoryListener interface. |
void |
categoryModified(CategoryEvent event)
From the CategoryListener interface. |
void |
categoryMoved(CategoryEvent event)
From the CategoryListener interface. |
void |
clearAllCounts(int objectType)
Resets the count to zero for all objects of this type. |
void |
clearCount(Forum forum)
Resets the read count for the given forum to 0 or does nothing if view counts are not enabled. |
void |
clearCount(ForumCategory category)
Resets the read count for the given category to 0 or does nothing if view counts are not enabled. |
void |
clearCount(ForumThread thread)
Resets the read count for the given thread to 0 or does nothing if view counts are not enabled. |
void |
forumAdded(ForumEvent event)
From the ForumListener interface. |
void |
forumDeleted(ForumEvent event)
Deletes all views associated with the forum being deleted. |
void |
forumMerged(ForumEvent event)
From the ForumListener interface. |
void |
forumModified(ForumEvent event)
From the ForumListener interface. |
void |
forumMoved(ForumEvent event)
From the ForumListener interface. |
int |
getCategoryCount(ForumCategory category)
Returns the number of times the given object has been read or -1 if view counts are not enabled. |
int |
getForumCount(Forum forum)
Returns the number of times the given object has been read or -1 if view counts are not enabled. |
static ViewCountManager |
getInstance()
Returns an instance of this class. |
int |
getThreadCount(ForumThread thread)
Returns the number of times the given object has been read or -1 if view counts are not enabled. |
static boolean |
isViewCountsEnabled()
|
void |
jivePropertyAdded(JivePropertyEvent event)
Fired when a jive property is added |
void |
jivePropertyModified(JivePropertyEvent event)
Fired when a jive property is modified |
void |
jivePropertyRemoved(JivePropertyEvent event)
Fired when a jive property is removed |
void |
threadAdded(ThreadEvent event)
From the ThreadListener interface. |
void |
threadDeleted(ThreadEvent event)
From the ThreadListener interface. |
void |
threadModerationModified(ThreadEvent event)
From the ThreadListener interface. |
void |
threadMoved(ThreadEvent event)
From the ThreadListener interface. |
void |
threadRated(ThreadEvent event)
From the ThreadListener interface. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static boolean isViewCountsEnabled()
public static ViewCountManager getInstance()
public int getCategoryCount(ForumCategory category)
category
- the category to check.
public int getForumCount(Forum forum)
forum
- the forum to check.
public int getThreadCount(ForumThread thread)
thread
- the category to check.
public void addCategoryCount(ForumCategory category)
category
- the category we're viewing.public void addForumCount(Forum forum)
forum
- the forum we're viewing.public void addThreadCount(ForumThread thread)
thread
- the thread we're viewing.public void clearCount(ForumCategory category) throws UnauthorizedException
category
- the category to reset the counts.
UnauthorizedException
- if the user is not an admin.public void clearCount(Forum forum) throws UnauthorizedException
forum
- the forum to reset the counts.
UnauthorizedException
- if the user is not an admin.public void clearCount(ForumThread thread) throws UnauthorizedException
thread
- the thread to reset the counts.
UnauthorizedException
- if the user is not an admin.public void clearAllCounts(int objectType)
objectType
- the type of object to reset counts.public void categoryAdded(CategoryEvent event)
CategoryListener
interface. In this implementation nothing is done for
this type of event.
categoryAdded
in interface CategoryListener
event
- the event object.public void categoryDeleted(CategoryEvent event)
CategoryListener
interface. Removes all view counts for the deleted
category or does nothing if view counts are not enabled.
categoryDeleted
in interface CategoryListener
event
- the category deleted event.public void categoryModified(CategoryEvent event)
CategoryListener
interface. In this implementation nothing is done for
this type of event.
categoryModified
in interface CategoryListener
event
- the event object.public void categoryMoved(CategoryEvent event)
CategoryListener
interface. In this implementation nothing is done for
this type of event.
categoryMoved
in interface CategoryListener
event
- the event object.public void forumAdded(ForumEvent event)
ForumListener
interface. In this implementation nothing is done for this
type of event.
forumAdded
in interface ForumListener
event
- the event object.public void forumDeleted(ForumEvent event)
forumDeleted
in interface ForumListener
event
- the delete event.public void forumModified(ForumEvent event)
ForumListener
interface. In this implementation nothing is done for this
type of event.
forumModified
in interface ForumListener
event
- the event object.public void forumMoved(ForumEvent event)
ForumListener
interface. In this implementation nothing is done for this
type of event.
forumMoved
in interface ForumListener
event
- the event object.public void forumMerged(ForumEvent event)
ForumListener
interface. Adds the forum view counts together or does
nothing if view counts are not enabled.
forumMerged
in interface ForumListener
event
- the merge event.public void threadAdded(ThreadEvent event)
ThreadListener
interface. In this implementation nothing is done for this
type of event.
threadAdded
in interface ThreadListener
event
- the event object.public void threadDeleted(ThreadEvent event)
ThreadListener
interface. Deletes the view count for the given thread or
does nothing if view counts are not enabled.
threadDeleted
in interface ThreadListener
event
- the delete event.public void threadMoved(ThreadEvent event)
ThreadListener
interface. In this implementation nothing is done for
this type of event.
threadMoved
in interface ThreadListener
event
- the event object.public void threadModerationModified(ThreadEvent event)
ThreadListener
interface. In this implementation nothing is done for
this type of event.
threadModerationModified
in interface ThreadListener
event
- the event object.public void threadRated(ThreadEvent event)
ThreadListener
interface. In this implementation nothing is done for
this type of event.
threadRated
in interface ThreadListener
event
- the event object.public void jivePropertyAdded(JivePropertyEvent event)
JivePropertyListener
jivePropertyAdded
in interface JivePropertyListener
event
- event firedpublic void jivePropertyRemoved(JivePropertyEvent event)
JivePropertyListener
jivePropertyRemoved
in interface JivePropertyListener
event
- event firedpublic void jivePropertyModified(JivePropertyEvent event)
JivePropertyListener
jivePropertyModified
in interface JivePropertyListener
event
- event fired
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |