oracle.discussions.ws.beans
Class AbstractContainerDefinition

java.lang.Object
oracle.discussions.ws.beans.AbstractContainerDefinition

Direct Known Subclasses:

CategoryDefinition, ForumDefinition

public class AbstractContainerDefinition

extends java.lang.Object

The class contains the minimal information necessary to create a container.

This is a super class for both CategoryDefinition and ForumDefinition.
CategoryDefinition is a category definition object, which is passed during the creation of a category.
ForumDefinition is a forum definition object, passed in creation of the forum.
These category/forum definition beans add onto the properties specified by abstract container definition bean.

See Also:

ForumDefinition, CategoryDefinition

Constructor Summary

AbstractContainerDefinition()
Default constructor.

Method Summary

void	setDescription(java.lang.String description) Sets the description of the container.
void	setDisplayName(java.lang.String displayname) Sets the displayname of the container.
void	setName(java.lang.String name) Sets the name of the container.
void	setWithAnnouncementBoard(boolean bWithAnnouncementBoard) Sets if the container created has an embedded AnnouncementsForum inside it.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractContainerDefinition

public AbstractContainerDefinition()

Default constructor.

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of the container.

Once set, the name cannot be edited.
Care should be taken that the name should not be same as the name of any other category/forum at the same level, at which, the container is being created.

Parameters:

name - - Name of the container

setDisplayName

public void setDisplayName(java.lang.String displayname)

Sets the displayname of the container.

The display name can be edited, after the container is created.
Care should be taken that the name should not be same as the name of any other category/forum at the same level, at which, the container is being created.

Parameters:

displayname - - Container's display name

setDescription

public void setDescription(java.lang.String description)

Sets the description of the container. The container's description should be suggestive enough to indicate the type of dicussions hosted in the container.

Parameters:

description - - Container's description.

setWithAnnouncementBoard

public void setWithAnnouncementBoard(boolean bWithAnnouncementBoard)

Sets if the container created has an embedded AnnouncementsForum inside it.

A container with an announcements forum is created, if bWithAnnouncementBoard is set to true. If set to false, the created container will not have an embedded announcements forum.

Parameters:

bWithAnnouncementBoard -