|
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 ArchiveManager
Manages the archive feature of Jive Forums. Archiving provides an automated method of dealing with old content. Three different archiving modes are available, and are set on a per-forum basis:
ForumFactory.getArchiveManager()
Field Summary | |
---|---|
static int |
DELETE_THREADS
An archive mode that specifies that threads should be deleted. |
static int |
MARK_THREADS
An archive mode that specifies that threads are marked as archived and left in their original forum. |
static int |
MOVE_THREADS
An archive mode that specifies that threads should be moved to another forum. |
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). |
Field Detail |
---|
static final int MARK_THREADS
static final int DELETE_THREADS
static final int MOVE_THREADS
Method Detail |
---|
boolean isArchivingEnabled(Forum forum)
forum
- the forum to check the status of.
void setArchivingEnabled(Forum forum, boolean enabled) throws UnauthorizedException
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.int getArchiveDays(Forum forum)
forum
- the forum to check the value on.
void setArchiveDays(Forum forum, int days) throws UnauthorizedException
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.int getArchiveMode(Forum forum)
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
forum
- the forum to check the archive mode of.
void setArchiveMode(Forum forum, int mode) throws UnauthorizedException
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
forum
- the forum to set the archive mode of.mode
- the archive mode.
UnauthorizedException
- if not an administrator of the forum.Forum getArchiveForum(Forum forum) throws UnauthorizedException
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.void setArchiveForum(Forum forum, Forum archiveForum) throws UnauthorizedException
forum
- the forum to set the "archive forum" of.archiveForum
- the "archive forum" for UnauthorizedException
- if not an admin of forum and
archiveForum.boolean isAutoArchiveEnabled() throws UnauthorizedException
UnauthorizedException
- if not a system administrator.void setAutoArchiveEnabled(boolean enabled) throws UnauthorizedException
enabled
- true if auto-archiving should be enabled.
UnauthorizedException
- if not a system administrator.int getAutoArchiveInterval() throws UnauthorizedException
UnauthorizedException
- if not a system administrator.void setAutoArchiveInterval(int interval) throws UnauthorizedException
interval
- the interval betwen auto archive executions (in hours).
UnauthorizedException
- if not a system administrator.boolean isBusy() throws UnauthorizedException
UnauthorizedException
- if not a system administrator.java.util.Date getLastArchivedDate() throws UnauthorizedException
UnauthorizedException
- if not a system administrator.void runArchiver() throws UnauthorizedException
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 |