com.axemble.vdoc.sdk.interfaces

Interface IForumSpace

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, Serializable

public interface IForumSpace
extends IElement, IDeletionSupport, ISecuritySupport, IProtocolSupport

The forum space interface.

Since:

2.0

Version:

1.0, 08/01/2009

Author:

vlygeros

See Also:

IForum, IDiscussion, IPost

Method Summary

Modifier and Type	Method and Description
int	getAlertNumberOfDiscussions() Returns the critical limit value of the forumspace in percent
String	getAlertRecipients() Get recipients for critical alert
String	getDescription() Gets the description of the forum space.
String	getForbiddenExtensions() Get forbidden file extensions
String	getFullAlertRecipients() Get recipients for full alert *
String	getLanguage() Gets the language of the forum space.
int	getMaxFileSize() Get max uploadable file size
int	getMaxLevels() Returns the maximum sub level of the forums managed by the forumspace
int	getMaxNumberOfDiscussions() Returns the subjects limit of the forumspace
String	getName() Gets the name of the forum space.
int	getTotalDiscussions() Gets the number of discussions.
int	getTotalForums() Gets the number of forums.
int	getTotalPosts() Gets the number of posts.
boolean	isAvatarsAllowed() Check if users are allowed to set an avatar
boolean	isNicknamesAllowed() Check if users are allowed to set a nickname
void	setAlertNumberOfDiscussions(int numberOfDiscussions) Sets the critical limit value of the forumspace
void	setAlertRecipients(String s) Set recipients for critical alert
void	setAvatarsAllowed(boolean b) Allow users to set an avatar or not
void	setDescription(String description) Sets the description of the forum space.
void	setForbiddenExtensions(String s) Set forbidden file extensions
void	setFullAlertRecipients(String newRecipients) Set recipients for full alert *
void	setLanguage(String language) Sets the language of the forum space.
void	setMaxFileSize(int i) Set max uploadable file size
void	setMaxLevels(int i) Set forum max sub level
void	setMaxNumberOfDiscussions(int numberOfDiscussions) Sets the subjects limit of the forumspace
void	setName(String name) Sets the name of the forum space.
void	setNicknamesAllowed(boolean b) Allow users to set a nickname or not

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Gets the name of the forum space.

Returns:

a String object.

setName

void setName(String name)

Sets the name of the forum space.

Parameters:

name - The new name to set.

getDescription

String getDescription()

Gets the description of the forum space.

Returns:

a String object.

setDescription

void setDescription(String description)

Sets the description of the forum space.

Parameters:

description - The new description to set.

getLanguage

String getLanguage()

Gets the language of the forum space.

Returns:

a String object.

setLanguage

void setLanguage(String language)

Sets the language of the forum space.

Parameters:

language - The new language to set.

getTotalForums

int getTotalForums()

Gets the number of forums.

Returns:

The total number of forums.

getTotalDiscussions

int getTotalDiscussions()

Gets the number of discussions.

Returns:

The total number of discussions.

getTotalPosts

int getTotalPosts()

Gets the number of posts.

Returns:

The total number of posts.

getMaxNumberOfDiscussions

int getMaxNumberOfDiscussions()

Returns the subjects limit of the forumspace

Returns:

long

getAlertNumberOfDiscussions

int getAlertNumberOfDiscussions()

Returns the critical limit value of the forumspace in percent

Returns:

int

getMaxLevels

int getMaxLevels()

Returns the maximum sub level of the forums managed by the forumspace

Returns:

int

setMaxNumberOfDiscussions

void setMaxNumberOfDiscussions(int numberOfDiscussions)

Sets the subjects limit of the forumspace

Parameters:

numberOfDiscussions - the limit

setAlertNumberOfDiscussions

void setAlertNumberOfDiscussions(int numberOfDiscussions)

Sets the critical limit value of the forumspace

Parameters:

numberOfDiscussions - the critical limit in percent

getAlertRecipients

String getAlertRecipients()

Get recipients for critical alert

Returns:

recipients for critical alert

setAlertRecipients

void setAlertRecipients(String s)

Set recipients for critical alert

Parameters:

s - the recipients for critical alert

getFullAlertRecipients

String getFullAlertRecipients()

Get recipients for full alert *

Returns:

recipients for full alert

setFullAlertRecipients

void setFullAlertRecipients(String newRecipients)

Set recipients for full alert *

Parameters:

newRecipients - recipients for full alert

getMaxFileSize

int getMaxFileSize()

Get max uploadable file size

Returns:

int

getForbiddenExtensions

String getForbiddenExtensions()

Get forbidden file extensions

Returns:

String

setMaxFileSize

void setMaxFileSize(int i)

Set max uploadable file size

Parameters:

i - the size

setForbiddenExtensions

void setForbiddenExtensions(String s)

Set forbidden file extensions

Parameters:

s - the extension separated by commas

setMaxLevels

void setMaxLevels(int i)

Set forum max sub level

Parameters:

i -

setNicknamesAllowed

void setNicknamesAllowed(boolean b)

Allow users to set a nickname or not

Parameters:

b - Boolean

setAvatarsAllowed

void setAvatarsAllowed(boolean b)

Allow users to set an avatar or not

Parameters:

b - Boolean

isNicknamesAllowed

boolean isNicknamesAllowed()

Check if users are allowed to set a nickname

Returns:

returns true if nicknames are allowed, false otherwise.

isAvatarsAllowed

boolean isAvatarsAllowed()

Check if users are allowed to set an avatar

Returns:

returns true if avatars are allowed, false otherwise.