|
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.DraftManagerProxy
public class DraftManagerProxy
Protection proxy for DraftManager instances.
Constructor Summary | |
---|---|
DraftManagerProxy(DraftManager manager,
AuthToken authToken,
Permissions permissions)
Creates a new ForumMessageDraftManagerProxy object. |
Method Summary | |
---|---|
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. |
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 |
getDraftsByUser(long userid)
Returns all drafts for a particular user. |
void |
initialize()
Initialize the manager. |
boolean |
isAutosaveEnabled()
Determines whether or not the system has been configured to allow for autosave in text fields. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DraftManagerProxy(DraftManager manager, AuthToken authToken, Permissions permissions)
manager
- the draft manager to protect by proxyauthToken
- the user's auth tokenpermissions
- the permissions to use with this proxy.Method Detail |
---|
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 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 java.util.Iterator getDraftsByUser(long userid)
DraftManager
getDraftsByUser
in interface DraftManager
userid
- the id of the user
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) throws UnauthorizedException
DraftManager
deleteDraft
in interface DraftManager
draft
- The draft to be deleted.
UnauthorizedException
- if the user associated with the draft is
not either a system admin or the owner of the draft.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 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
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |