|
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.database.DbDraftManager
public class DbDraftManager
Database implementation of the DraftManager interface.
Method Summary | |
---|---|
void |
announcementCreated(AnnouncementEvent event)
Fired when an announcement has been added to the system. |
void |
announcementDeleted(AnnouncementEvent event)
Fired when an announcement is about to be deleted from the system. |
void |
announcementModified(AnnouncementEvent event)
Fired when portions of an announcement have been modified. |
void |
anonymousVoteAdded(PollEvent event)
Fired when an anonymous vote is added to a poll. |
void |
anonymousVoteModified(PollEvent event)
Fired when an anonymous poll vote is modified. |
void |
anonymousVoteRemoved(PollEvent event)
Fired when an anonymous poll vote is removed. |
void |
categoryAdded(CategoryEvent event)
Fired when a category has been added to the system. |
void |
categoryDeleted(CategoryEvent event)
Fired when a category is about to be deleted from the system. |
void |
categoryModified(CategoryEvent event)
Fired when a category has been modified. |
void |
categoryMoved(CategoryEvent event)
Fired when a category has been moved from one category to another. |
Draft |
createDraft(Draft draft)
Creates a new draft. |
void |
deleteDraft(Draft draft)
Delete an existing draft. |
void |
destroy()
Notifies the manager to release any resources that may be holding on too. |
void |
forumAdded(ForumEvent event)
Fired when a forum has been added to the system. |
void |
forumDeleted(ForumEvent event)
Fired when a forum is about to be deleted from the system. |
void |
forumMerged(ForumEvent event)
Fired when a forum is merged into another forum. |
void |
forumModified(ForumEvent event)
Fired when a forum is modified. |
void |
forumMoved(ForumEvent event)
Fired when a forum has been moved from one category to another. |
int |
getAutosaveInterval()
Returns the setting for the number of seconds between autosave invocations when autosave is enabled for a text field. |
Draft |
getDraft(long draftID)
Returns a draft by draft ID or null if no draft exists with the specified draftID. |
Draft |
getDraft(long userID,
int draftType,
int objectType,
long objectID)
Returns the draft for a particular user associated with a particular forum, thread and / or message. |
java.util.Iterator |
getDraftsByObjectID(int objectType,
long objectID)
|
java.util.Iterator |
getDraftsByUser(long userid)
Returns all drafts for a particular user. |
static DbDraftManager |
getInstance()
|
void |
initialize()
Initialize the manager. |
boolean |
isAutosaveEnabled()
Determines whether or not the system has been configured to allow for autosave in text fields. |
void |
messageAdded(MessageEvent event)
Fired when a message has been added to the system. |
void |
messageDeleted(MessageEvent event)
Fired when a message is about to be deleted from the system. |
void |
messageModerationModified(MessageEvent event)
Fired when the moderation value of a message has been changed. |
void |
messageModified(MessageEvent event)
Fired when portions of a message have been modified. |
void |
messageMoved(MessageEvent event)
Fired when a message is moved to another thread. |
void |
messageRated(MessageEvent event)
Fired when a message has been rated. |
void |
pollCreated(PollEvent event)
Fired when a poll is created. |
void |
pollDeleted(PollEvent event)
Fired when a poll is deleted. |
void |
setAutosaveEnabled(boolean enable)
Enables or disables autosave. |
void |
setAutosaveInterval(int interval)
Sets the amount of time (in seconds) that the browser should wait between updating the draft. |
void |
updateDraft(Draft draft)
Update an existing draft. |
void |
voteAdded(PollEvent event)
Fired when a vote is added to a poll. |
void |
voteModified(PollEvent event)
Fired when a poll vote is modified. |
void |
voteRemoved(PollEvent event)
Fired when a poll vote is removed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DbDraftManager getInstance()
public void initialize()
JiveManager
This method is used internally by Jive during application startup and should not be called during normal usage of the class.
initialize
in interface JiveManager
public void destroy()
JiveManager
destroy
in interface JiveManager
public Draft createDraft(Draft draft) throws UnauthorizedException
DraftManager
createDraft
in interface DraftManager
draft
- a Draft
UnauthorizedException
public Draft getDraft(long draftID)
DraftManager
getDraft
in interface DraftManager
draftID
- the ID of the draft to return.
public java.util.Iterator getDraftsByObjectID(int objectType, long objectID)
public java.util.Iterator getDraftsByUser(long userid)
DraftManager
getDraftsByUser
in interface DraftManager
userid
- the id of the user
public Draft getDraft(long userID, int draftType, int objectType, long objectID)
DraftManager
getDraft
in interface DraftManager
userID
- the user to find draft fordraftType
- the draft type to filter the results byobjectType
- the type of container to filter byobjectID
- the id of a specific container to filter by
public void updateDraft(Draft draft) throws UnauthorizedException
DraftManager
updateDraft
in interface DraftManager
draft
- The draft to be updated.
UnauthorizedException
- if the user associated with the draft is
not either a system admin or the owner of the draft.public void deleteDraft(Draft draft)
DraftManager
deleteDraft
in interface DraftManager
draft
- The draft to be deleted.public boolean isAutosaveEnabled()
DraftManager
isAutosaveEnabled
in interface DraftManager
public int getAutosaveInterval()
DraftManager
getAutosaveInterval
in interface DraftManager
public void setAutosaveEnabled(boolean enable)
DraftManager
setAutosaveEnabled
in interface DraftManager
public void setAutosaveInterval(int interval)
DraftManager
setAutosaveInterval
in interface DraftManager
public void categoryAdded(CategoryEvent event)
CategoryListener
categoryAdded
in interface CategoryListener
event
- the event object.public void categoryDeleted(CategoryEvent event)
CategoryListener
categoryDeleted
in interface CategoryListener
event
- the event object.public void categoryMoved(CategoryEvent event)
CategoryListener
categoryMoved
in interface CategoryListener
event
- the event object.public void categoryModified(CategoryEvent event)
CategoryListener
categoryModified
in interface CategoryListener
event
- the event object.public void forumAdded(ForumEvent event)
ForumListener
forumAdded
in interface ForumListener
event
- the event object.public void forumDeleted(ForumEvent event)
ForumListener
forumDeleted
in interface ForumListener
event
- the event object.public void forumModified(ForumEvent event)
ForumListener
forumModified
in interface ForumListener
event
- the event object.public void forumMoved(ForumEvent event)
ForumListener
forumMoved
in interface ForumListener
event
- the event object.public void forumMerged(ForumEvent event)
ForumListener
forumMerged
in interface ForumListener
event
- the event object.public void messageAdded(MessageEvent event)
MessageListener
messageAdded
in interface MessageListener
event
- the event object.public void messageDeleted(MessageEvent event)
MessageListener
messageDeleted
in interface MessageListener
event
- the event object.public void messageMoved(MessageEvent event)
MessageListener
messageMoved
in interface MessageListener
event
- the event object.public void messageModified(MessageEvent event)
MessageListener
messageModified
in interface MessageListener
event
- the event object.public void messageModerationModified(MessageEvent event)
MessageListener
messageModerationModified
in interface MessageListener
event
- the event object.public void messageRated(MessageEvent event)
MessageListener
messageRated
in interface MessageListener
event
- the event object.public void announcementCreated(AnnouncementEvent event)
AnnouncementListener
announcementCreated
in interface AnnouncementListener
event
- the event object.public void announcementDeleted(AnnouncementEvent event)
AnnouncementListener
announcementDeleted
in interface AnnouncementListener
event
- the event object.public void announcementModified(AnnouncementEvent event)
AnnouncementListener
announcementModified
in interface AnnouncementListener
event
- the event object.public void pollCreated(PollEvent event)
PollListener
pollCreated
in interface PollListener
event
- the PollEventpublic void pollDeleted(PollEvent event)
PollListener
pollDeleted
in interface PollListener
event
- the PollEventpublic void voteAdded(PollEvent event)
PollListener
voteAdded
in interface PollListener
event
- the PollEvent.public void anonymousVoteAdded(PollEvent event)
PollListener
anonymousVoteAdded
in interface PollListener
event
- the PollEvent.public void voteModified(PollEvent event)
PollListener
voteModified
in interface PollListener
event
- the PollEvent.public void anonymousVoteModified(PollEvent event)
PollListener
anonymousVoteModified
in interface PollListener
event
- the PollEvent.public void voteRemoved(PollEvent event)
PollListener
voteRemoved
in interface PollListener
event
- the PollEvent.public void anonymousVoteRemoved(PollEvent event)
PollListener
anonymousVoteRemoved
in interface PollListener
event
- the PollEvent.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |