Oracle Collaboration Suite Discussions Web Services Java API Reference
10g (10.1.2.2)

Part No. B28210-01


oracle.discussions.ws.beans
Class ForumDefinition

java.lang.Object
  extended byoracle.discussions.ws.beans.AbstractContainerDefinition
      extended byoracle.discussions.ws.beans.ForumDefinition


public class ForumDefinition
extends AbstractContainerDefinition

Bean representing the properties of the forum, being created.

The properties specified in the bean are applied to a newly created forum.
Care should be taken so that the forum name and display-name should not be same as any other category/forum's name, displayname at the same level, respectively. An exception is raised if the above condition is not followed.
Default properties are applied to the forum, when created.The properties can be updated using forum settings bean.

See Also:
CategoryDefinition, AbstractContainerDefinition, ForumSettings

Constructor Summary
ForumDefinition()
          Default constructor

 

Method Summary
 void setEmailAddress(java.lang.String email)
          Sets the forum's email address.
 void setEmailRoutingPolicy(int iEmailRoutingPolicy)
          Sets the email routing policy.
 void setPublicForum(boolean isPublic)
          Sets, if the forum is publicly accessible.

 

Methods inherited from class oracle.discussions.ws.beans.AbstractContainerDefinition
setDescription, setDisplayName, setName, setWithAnnouncementBoard

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ForumDefinition

public ForumDefinition()
Default constructor

Method Detail

setEmailAddress

public void setEmailAddress(java.lang.String email)
Sets the forum's email address.

Email address should be unique. An exception is raised otherwise. A forum's email address should be of the form <valid name>@<email domain>. The email domain, should be same as the domain, for which Discussions internal admin is provisioned.
An exception is raised, if the email address is not in the above mentioned format.

Parameters:
email - - Forum's email address.

setPublicForum

public void setPublicForum(boolean isPublic)
Sets, if the forum is publicly accessible. If the forum is publicly accessible, then any user can access the forum and its elements, though he is not a forum member.
Three levels of public access are supported by Oracle Discussions. If the value set is true, then public access without anonymous posting settings is applied to the forum.The can be changed later on, editing the forum's settings.
Parameters:
isPublic - - boolean value representing if the forum is public

setEmailRoutingPolicy

public void setEmailRoutingPolicy(int iEmailRoutingPolicy)
Sets the email routing policy.

iEmailRoutingPolicy specifies how email message will be routed to the board.
It can take two parameters:

if iEmailRoutingPoicy is EMAIL_ALIAS_ROUTING_ENABLED, Discussions SDK will try to create an email alias with the provided boardEmail. Otherwise, it will treat the provided email address as an existing alias and assume the incoming mail will be delivered correctly.

Copyright © 2005, Oracle. All rights reserved.