com.axemble.vdoc.sdk.interfaces

Interface IForum

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, IUriSupport, Serializable

public interface IForum
extends IElement, IDeletionSupport, IUriSupport, ISecuritySupport, IProtocolSupport

The forum interface.

Since:

2.0

Version:

1.0, 08/01/2009

Author:

vlygeros

See Also:

IDiscussion, IPost

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the description of the forum.
Collection	getDiscussions() Gest the forum discussions.
Collection	getForums() Gets the sub forums.
String	getLabel() Gets the label of the forum.
IForum	getParentForum() Gets the parent forum.
boolean	isCategory() Checks if the forum element is a category of forums
void	setDescription(String description) Sets the description of the forum.
void	setLabel(String label) Sets the label of the forum.

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.IUriSupport

getURI

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

getProtocolURI, getProtocolURI

Method Detail

getLabel

String getLabel()

Gets the label of the forum.

Returns:

a String value.

setLabel

void setLabel(String label)

Sets the label of the forum.

Parameters:

label - The new label to set the forum with.

getDescription

String getDescription()

Gets the description of the forum.

Returns:

a String value.

setDescription

void setDescription(String description)

Sets the description of the forum.

Parameters:

description - The new description to set the forum with

getParentForum

IForum getParentForum()

Gets the parent forum.

Returns:

a IForum object.

getForums

Collection getForums()

Gets the sub forums.

Returns:

a collection of IForum objects.

getDiscussions

Collection getDiscussions()

Gest the forum discussions.

Returns:

a collection of IDiscussion objects.

isCategory

boolean isCategory()

Checks if the forum element is a category of forums

Returns:

true if it is a category of forums, false otherwise.