oracle.discussions.ws.beans
Class ForumSettings

java.lang.Object
oracle.discussions.ws.beans.AbstractContainerSettings
oracle.discussions.ws.beans.ForumSettings

public class ForumSettings

extends AbstractContainerSettings

Represents the the settings of a Oracle Discussions forum.

Inherits the common settings from AbstractContainerSettings. The settings control the behaviour of the forum.

See Also:

AbstractContainerSettings

Constructor Summary

ForumSettings()
Default constructor

Method Summary

int	getAttachmentMaxSize() Returns the attachment max size, for all the messages in the forum.
java.lang.String	getBeginQuotePrefix() Returns the begin quote prefix.
int	getComposeEditor() Returns an integer value, representing the editor for the message composing.
int	getEditDeletePolicy() Returns the message edit delete policy in the forum.
java.lang.String	getEmailAddress() Returns the email address of the forum.
int	getEmailForwardPolicy() Returns the email forward policy for the forum.
int	getEmailInboundPolicy() Returns the email inbound policy of the forum.
int	getEmailRoutingPolicy()
int	getFlatViewPagingSize() Returns the message flat view page size.
java.lang.String	getOutgoingEmailDL() Returns the outgoing email DL.
java.lang.String	getOutgoingEmailDLBodyFormat() Returns the outgoing email DL body format.
java.lang.String	getOutgoingEmailDLSubjectFormat() Returns the outgoing email DL subject format
int	getPublicAccessPolicy() Returns the forum's public access policy.
java.lang.String	getReplyPrefix() Returns the reply prefix.
int	getThreadView() Returns if the messages are displayed as threaded view /flat view.
boolean	isCanAttach() Returns if the attachments are enabled in this forum.
boolean	isOriginalQuoted() Returns if the messages are originally quoted.
void	setAttachmentMaxSize(int iMaxSize) Sets the attachment max size, for all the messages in the forum.
void	setBeginQuotePrefix(java.lang.String beginQuotePrefix) Sets the begin quote prefix.
void	setCanAttach(boolean bool) Sets if the attachments are enabled in this forum.
void	setComposeEditor(int iComposeEditor)
void	setEditDeletePolicy(int policy) Sets the message edit/delete policy in the forum.
void	setEmailAddress(java.lang.String emailAddress) Sets the email address of the forum.
void	setEmailForwardPolicy(int policy) Sets the email forward policy for the forum.
void	setEmailInboundPolicy(int policy) Sets the email inbound policy for the forum.
void	setEmailRoutingPolicy(int policy)
void	setFlatViewPagingSize(int size) Sets the message flat view page size.
void	setOriginalQuoted(boolean bool) Sets if the messages are originally quoted.
void	setOutgoingEmailDL(java.lang.String dl) Sets the outgoing email DL address.
void	setOutgoingEmailDLBodyFormat(java.lang.String format) Sets the outgoing email DL body format.
void	setOutgoingEmailDLSubjectFormat(java.lang.String format) Sets the outgoing email DL subject format.
void	setPublicAccessPolicy(int policy) Sets the forum's public access policy.
void	setReplyPrefix(java.lang.String rPrefix) Sets the reply prefix.
void	setThreadView(int num) Sets if the messages are displayed in threaded mode/flat view mode.

Methods inherited from class oracle.discussions.ws.beans.AbstractContainerSettings

getCreationDate, getCreator, getDescription, getDisplayName, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

ForumSettings

public ForumSettings()

Default constructor

Method Detail

setBeginQuotePrefix

public void setBeginQuotePrefix(java.lang.String beginQuotePrefix)

Sets the begin quote prefix.

Parameters:

beginQuotePrefix - - Begin quote prefix

getBeginQuotePrefix

public java.lang.String getBeginQuotePrefix()

Returns the begin quote prefix.

Returns:

String -

setAttachmentMaxSize

public void setAttachmentMaxSize(int iMaxSize)

Sets the attachment max size, for all the messages in the forum.

Parameters:

iMaxSize - - Attahment max size in bytes

getAttachmentMaxSize

public int getAttachmentMaxSize()

Returns the attachment max size, for all the messages in the forum.

Returns:

int - Attahment max size in bytes

setCanAttach

public void setCanAttach(boolean bool)

Sets if the attachments are enabled in this forum. Set to true if attachments are to be enabled, false otherwise.

Parameters:

bool - - indicates of attachments are enabled

isCanAttach

public boolean isCanAttach()

Returns if the attachments are enabled in this forum. Returns true if attachments are enabled, false otherwise.

Returns:

bool - indicates of attachments are enabled

setComposeEditor

public void setComposeEditor(int iComposeEditor)

getComposeEditor

public int getComposeEditor()

Returns an integer value, representing the editor for the message composing. Returns

• an integer value 1 - if the editor setting is a plain text editor
• an integer value 2 - if the editor setting is a rich txt editor

Returns:

int - Value for the compose editor

setEditDeletePolicy

public void setEditDeletePolicy(int policy)

Sets the message edit/delete policy in the forum.

Various acceptible values for the edit/delete policy setting are

• Never allow edit/delete - Represented by an integer value 1. Indicates that the messages, posted once, can never be edited/deleted.
• Allow edit/delete without reply - Represented by an integer value 2. Indicates that the messages can be edited/deleted only if they do not have replies.
• Allow edit/delete - Represented by an integer value 3. Indicates that the messages can always be edited/deleted.

Forum moderators can override these policies.

Parameters:

policy - - Edit/delete policy for messages

getEditDeletePolicy

public int getEditDeletePolicy()

Returns the message edit delete policy in the forum.

Various acceptible values for the edit/delete policy setting are

• Never allow edit/delete - Represented by an integer value 1. Indicates that the messages, posted once, can never be edited/deleted.
• Allow edit/delete without reply - Represented by an integer value 2. Indicates that the messages can be edited/deleted only if they do not have replies.
• Allow edit/delete - Represented by an integer value 3. Indicates that the messages can always be edited/deleted.

Forum moderators can override these policies.

Returns:

int - Edit/delete policy for messages

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

Sets the email address of the forum.

If the forum's email is set, it cannot be edited again.An exception is raised otherwise.
The forum email should be unique in the Oracle Discussions system.It should be of the form <string>@<email-domain>. The email domain should be same as the domain, configured for the Discussions internal administrator.

Parameters:

emailAddress - - forum's email

getEmailAddress

public java.lang.String getEmailAddress()

Returns the email address of the forum.

Returns:

String - forum's email

setFlatViewPagingSize

public void setFlatViewPagingSize(int size)

Sets the message flat view page size. The size represents the number of messages displayed per page, in the flat view mode.

Parameters:

size - - page size

getFlatViewPagingSize

public int getFlatViewPagingSize()

Returns the message flat view page size.

Returns:

int - page size

setThreadView

public void setThreadView(int num)

Sets if the messages are displayed in threaded mode/flat view mode.

Accesptible values are

• an integer value 1 - Representing the message flat view mode.
• an integer value 2 - Representing the message threaded view mode.

Parameters:

num - - Value to set the setting

getThreadView

public int getThreadView()

Returns if the messages are displayed as threaded view /flat view.

Returns:

int - Value to set the setting

setEmailForwardPolicy

public void setEmailForwardPolicy(int policy)

Sets the email forward policy for the forum. Acceptible values are

• Email forward original - Represented by an integer value 0. Indicates that the email messages are forwarded as original messages.
• Email forward as notification - Represented by an integer value 1. Indicates that the email messages are forwarded as notifications.

Parameters:

policy - - email forward policy

getEmailForwardPolicy

public int getEmailForwardPolicy()

Returns the email forward policy for the forum.

Returns:

int - email forward policy

setEmailInboundPolicy

public void setEmailInboundPolicy(int policy)

Sets the email inbound policy for the forum. Acceptible values for the email inbound policy are

• Email inbound none - Represented by an integer value 0. Indicates that all the messages sent to teh forum's email address are ignored.
• Email inbound restricted - Represented by an integer value 1. Indicates that email messages sent to the forum email address will be posted to the forum only if the author is a Forum Writer.
• Email inbound open - Represented by an integer value 2. Indicates that the email messages sent to the forum email address will always be posted to the forum.

Parameters:

policy - - email inbound policy

getEmailInboundPolicy

public int getEmailInboundPolicy()

Returns the email inbound policy of the forum.

Returns:

int - email inbound policy

setOutgoingEmailDL

public void setOutgoingEmailDL(java.lang.String dl)

Sets the outgoing email DL address.

Parameters:

dl - - Outgoing email dl.

getOutgoingEmailDL

public java.lang.String getOutgoingEmailDL()

Returns the outgoing email DL.

Returns:

String - Outgoing email dl

setOutgoingEmailDLBodyFormat

public void setOutgoingEmailDLBodyFormat(java.lang.String format)

Sets the outgoing email DL body format.

Parameters:

format - - Outgoing email dl body format

getOutgoingEmailDLBodyFormat

public java.lang.String getOutgoingEmailDLBodyFormat()

Returns the outgoing email DL body format.

Returns:

String - Outgoing email dl body format

setOutgoingEmailDLSubjectFormat

public void setOutgoingEmailDLSubjectFormat(java.lang.String format)

Sets the outgoing email DL subject format.

Parameters:

format - - Outgoing email dl subject format

getOutgoingEmailDLSubjectFormat

public java.lang.String getOutgoingEmailDLSubjectFormat()

Returns the outgoing email DL subject format

Returns:

String - Outgoing email dl subject format

setReplyPrefix

public void setReplyPrefix(java.lang.String rPrefix)

Sets the reply prefix.

This string is by default prefixed to all the replies' subject.
For example, if a message subject is "My first message", then the default reply prefix for the message reply would be "Re : My first message".

Parameters:

rPrefix - - reply prefix

getReplyPrefix

public java.lang.String getReplyPrefix()

Returns the reply prefix.

Returns:

String - reply prefix

setOriginalQuoted

public void setOriginalQuoted(boolean bool)

Sets if the messages are originally quoted.

Parameters:

bool - - if messages are original quoted.

isOriginalQuoted

public boolean isOriginalQuoted()

Returns if the messages are originally quoted.

Returns:

boolean - if messages are original quoted.

setPublicAccessPolicy

public void setPublicAccessPolicy(int policy)

Sets the forum's public access policy.

Public access policy specifies if the forum is accessible to non-forum users. Acceptible values for public access policy are

• No public access - Represented by an integer value 1. Indicates that the forum is not accessible to non-members.
• public access without anonymous posting - Represented by an integer value 2. Indicates that the forum is accessible as read-only to non-members.
• Public access with anonymous posting - Represented by an integer value 3. Indicates that all the users can post to the forum.

Parameters:

policy - - public access policy

getPublicAccessPolicy

public int getPublicAccessPolicy()

Returns the forum's public access policy.

Returns:

int - public access policy

setEmailRoutingPolicy

public void setEmailRoutingPolicy(int policy)

getEmailRoutingPolicy

public int getEmailRoutingPolicy()