|
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.ArchiveManagerProxy
public class ArchiveManagerProxy
Protection proxy for the ArchiveManager class.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.ArchiveManager |
---|
DELETE_THREADS, MARK_THREADS, MOVE_THREADS |
Constructor Summary | |
---|---|
ArchiveManagerProxy(ArchiveManager archiveManager,
AuthToken authToken,
Permissions permissions)
|
Method Summary | |
---|---|
int |
getArchiveDays(Forum forum)
Returns the number of days that threads in forum must be inactive before being archived. |
Forum |
getArchiveForum(Forum forum)
Returns the "archive forum" for the specified forum. |
int |
getArchiveMode(Forum forum)
Returns the archive mode for the forum. |
int |
getAutoArchiveInterval()
Returns the inverval between auto archive executions (in hours). |
java.util.Date |
getLastArchivedDate()
Returns the date the archiving process was last run. |
boolean |
isArchivingEnabled(Forum forum)
Returns true if archiving is enabled for the specified forum. |
boolean |
isAutoArchiveEnabled()
Returns true if auto-archiving is enabled. |
boolean |
isBusy()
Returns true if the archiving process is currently running. |
void |
runArchiver()
Manually runs the archiving process. |
void |
setArchiveDays(Forum forum,
int days)
Sets the number of days that threads in forum must be inactive before being archived. |
void |
setArchiveForum(Forum forum,
Forum archiveForum)
Sets the "archive forum" for the specified forum. |
void |
setArchiveMode(Forum forum,
int mode)
Returns the archive mode for the forum. |
void |
setArchivingEnabled(Forum forum,
boolean enabled)
Enables or disables archiving for the specified forum. |
void |
setAutoArchiveEnabled(boolean enabled)
Enables or disables auto-archiving. |
void |
setAutoArchiveInterval(int interval)
Sets the inverval between auto archive executions (in hours). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ArchiveManagerProxy(ArchiveManager archiveManager, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public boolean isArchivingEnabled(Forum forum)
ArchiveManager
isArchivingEnabled
in interface ArchiveManager
forum
- the forum to check the status of.
public void setArchivingEnabled(Forum forum, boolean enabled) throws UnauthorizedException
ArchiveManager
setArchivingEnabled
in interface ArchiveManager
forum
- the forum to set the status of.enabled
- true if archiving should be enabled for the forum.
UnauthorizedException
- if not an administrator of the forum.public int getArchiveDays(Forum forum)
ArchiveManager
getArchiveDays
in interface ArchiveManager
forum
- the forum to check the value on.
public void setArchiveDays(Forum forum, int days) throws UnauthorizedException
ArchiveManager
setArchiveDays
in interface ArchiveManager
forum
- the forum to set the value on.days
- the number of days a thread must be inactive before being
archived.
UnauthorizedException
- if not an admin of the forum.public int getArchiveMode(Forum forum)
ArchiveManager
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
getArchiveMode
in interface ArchiveManager
forum
- the forum to check the archive mode of.
public void setArchiveMode(Forum forum, int mode) throws UnauthorizedException
ArchiveManager
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
setArchiveMode
in interface ArchiveManager
forum
- the forum to set the archive mode of.mode
- the archive mode.
UnauthorizedException
- if not an administrator of the forum.public Forum getArchiveForum(Forum forum) throws UnauthorizedException
ArchiveManager
getArchiveForum
in interface ArchiveManager
forum
- the forum to get the "archive forum" of.
UnauthorizedException
- if not an admin of forum or
does not have read permission on the archive forum being returned.public void setArchiveForum(Forum forum, Forum archiveForum) throws UnauthorizedException
ArchiveManager
setArchiveForum
in interface ArchiveManager
forum
- the forum to set the "archive forum" of.archiveForum
- the "archive forum" for UnauthorizedException
- if not an admin of forum and
archiveForum.public boolean isAutoArchiveEnabled() throws UnauthorizedException
ArchiveManager
isAutoArchiveEnabled
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public void setAutoArchiveEnabled(boolean enabled) throws UnauthorizedException
ArchiveManager
setAutoArchiveEnabled
in interface ArchiveManager
enabled
- true if auto-archiving should be enabled.
UnauthorizedException
- if not a system administrator.public int getAutoArchiveInterval() throws UnauthorizedException
ArchiveManager
getAutoArchiveInterval
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public void setAutoArchiveInterval(int interval) throws UnauthorizedException
ArchiveManager
setAutoArchiveInterval
in interface ArchiveManager
interval
- the interval betwen auto archive executions (in hours).
UnauthorizedException
- if not a system administrator.public boolean isBusy() throws UnauthorizedException
ArchiveManager
isBusy
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public java.util.Date getLastArchivedDate() throws UnauthorizedException
ArchiveManager
getLastArchivedDate
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public void runArchiver() throws UnauthorizedException
ArchiveManager
runArchiver
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |