oracle.discussions.sdk
Interface TdBoardSettings

All Superinterfaces:

java.util.Map, TdContainerSettings

public interface TdBoardSettings

extends TdContainerSettings

BoardSettings represent the board attributes defined when the board is created.

Extends oracle.discussions.sdk.TdContainerSettings which define the settings which are common to all the containers in discussions.
These settings define the

• Accessability of the board for users/groups
• Email policy of the board
• Message reply policy
• Default web editor policy
• Attachment settings for the threads/messages in the board.
• and ther properties.
  They can be configured and edited by the creator of the board or any user with the role higher than or equivalent to that.
  

Oracle discussions elements names have been changed in the webui compared to that of sdk portion. The existing names to the new names mapping is as shown.

• Facility - Category
• Board - Forum
• Delete - Hide

Sample code snippet illustrating the usage of TdBoardSettings.

 //Get the integer representing the board edit/delete policy from the board settings object
 //tdbs is a TdBoardSettings instance.
 int iBrdDeletePolicy = tdbs.getBoardEditDeletePolicy();
 switch(iBrdDeletePolicy)
 {
   case TdBoardSettings.NO_BOARD_EDIT_DELETE:
     // Do something.....
 }

Since:

OCS 10.1.1

See Also:

TdBoard.java, TdContainerPermissions.java

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static int	ALLOW_BOARD_EDIT_DELETE Indicates that the messages posted into this board can always be edited/deleted.
static int	BOARD_EDIT_DELETE_ONLY_NO_REPLY Indicates that the messages posted into this board can be edited/deleted only if there are no replies posted to them.
static java.lang.String	BOARD_EMAIL_ADDRESS Specifies the board email address.
static java.lang.String	BOARD_LOCKED Specifies if the board is locked.
static java.lang.String	CAN_ATTACH Specifies if the attachments are allowed for teh threads/messages posted in this board.
static java.lang.String	CLIP_POSTFIX Specifies the suffix to be added to the clipped messages in the board.
static java.lang.String	COMPOSE_EDITOR Specifies the editor to be used to compose threads/messages in the board.
static int	COMPOSE_EDITOR_PLAIN Indicates that the editor used is a plain text editor.
static int	COMPOSE_EDITOR_RICH Indicates that the editor used is a rich text editor.
static java.lang.String	EMAIL_FORWARD_POLICY Specifies the email forwarding policy for this board.
static int	EMAIL_FWD_AS_NOTIFICATION Indicates that messages posted to this board are forwarded as notifications.
static int	EMAIL_FWD_AS_ORIGINAL Indicates that messages posted to this board are forwarded as email messages only.
static int	EMAIL_INBOUND_NONE Indicates that none of the incoming emails are posted as messages in the board.
static int	EMAIL_INBOUND_OPEN Indicates that all the incoming emails into the board are posted as messages into the board.
static java.lang.String	EMAIL_INBOUND_POLICY Specifies the inbound email policy for this board.
static int	EMAIL_INBOUND_RESTRICTED Indicates that incoming emails will be posted as messages into the board only if the sender plays a board writer or higher role.
static java.lang.String	FLAT_VIEW_PAGING_SIZE Specifies the number of replies displayed per page in the flat view.
static java.lang.String	MAX_ATTACH_SIZE Specifies the maximum size of attachments that can be attached per thread/message.
static java.lang.String	MESSAGE_EDIT_DELETE_POLICY Specifies the edit/hide policy for the messages posted into this board.
static int	NO_BOARD_EDIT_DELETE Indicates that the messages posted into this board cannot be edited/deleted at all.
static int	NO_PUBLIC_ACCESS Indicates that the board is not publicly accessible.
static java.lang.String	OUTGOING_EMAIL_DL Specifies the outgoing email address from the board.
static java.lang.String	OUTGOING_EMAIL_DL_BODY_FORMAT Specifies the outgoing email body format.
static java.lang.String	OUTGOING_EMAIL_DL_SUBJECT_FORMAT Specifies the outgoing email subject format.
static java.lang.String	PUBLIC_ACCESS_POLICY Specifies teh public access policy for this board.
static int	PUBLIC_ACCESS_WITH_ANONYMOUS_POSTING Indicates that the board is publicly acessible.
static int	PUBLIC_ACCESS_WITHOUT_ANONYMOUS_POSTING Indicates that the board is publicly acessible.
static java.lang.String	REPLY_PREFIX Specifies the prefix string to be applied to all the message replies sent from this board.
static java.lang.String	REPLY_QUOTE_POLICY Specifies if the original message is to be appended as prefix string to the message replies sent from this board.
static java.lang.String	REPLY_QUOTE_STRING Specifies the quote string to be prefixed to the message replies sent from this board.
static java.lang.String	THREAD_VIEW Specifies the default view of the messages displayed in a page.
static int	THREAD_VIEW_FLAT Indicates that the messages are displayed in a flat view.
static int	THREAD_VIEW_THREADED Indicates that the messages are displayed in threaded view.

Fields inherited from interface oracle.discussions.sdk.TdContainerSettings

DESCRIPTION, DISPLAY_NAME, UNDEFINED_INT_SETTINGS

Method Summary

java.lang.String	getBeginQuotePrefix() Returns the string to be used as a prefix when quoting a message.
int	getBoardAttachmentMaxSize() Returns the maximum attachment size per thread/message.
boolean	getBoardCanAttach() Returns a boolean value indicating whether the attachments are allowed or not.
int	getBoardComposeEditor() Returns the editor policy in place.
int	getBoardEditDeletePolicy() Returns the policy defined specifying the message edit/delete settings in board.
java.lang.String	getBoardEmail() Returns the email address of the board.
int	getBoardFlatViewPagingSize() Returns the number of replies set per page.
int	getBoardThreadView() Returns the default view in place.
int	getEmailForwardPolicy() Returns the email forward policy in place.
int	getEmailInboundPolicy() Returns the email inbound policy in place for the board.
java.lang.String	getOutgoingEmailDL() Returns the text representing the email address for the outgoing emails from the board.
java.lang.String	getOutgoingEmailDLBodyFormat() Returns the text representing the body format for the outgoing emails from the board.
java.lang.String	getOutgoingEmailDLSubjectFormat() Returns the text representing the subject format for the outgoing emails from the board.
int	getPublicAccessPolicy() Returns the board access policy in place.
java.lang.String	getReplyPrefix() Returns the string to be prefixed to a message subject when building a reply (e.g.
boolean	isLocked() Returns a boolean value representing if a board is locked.
boolean	isOriginalQuoted() Returns true if when building a reply message, the original message should be included as a quote.
void	lock(boolean bLocked) Locks the board if the boolean argument passed is true.
void	setBeginQuotePrefix(java.lang.String beginQuotePrefix) Sets the string to be used as a prefix when quoting a message.
void	setBoardAttachmentMaxSize(int iAttachmentMaxSize) Defines the maximum size of the attachments allowed per thread/message.
void	setBoardCanAttach(boolean bCanAttach) Specifies a boolean value indicating wheter attachments in this board to threads/messages are allowed.
void	setBoardComposeEditor(int iBrdComposeEditor) Defines the default editor to be used for posting threads/messages in the board.
void	setBoardEditDeletePolicy(int iBrdEditDeletePolicy) Specifies the policy for the message hide/edit in this board.
void	setBoardEmail(java.lang.String boardEmail) Specifies teh board email address.
void	setBoardFlatViewPagingSize(int iBrdFlatViewPagingSize) Specifies the number of replies to be displayed at a time in a page.
void	setBoardThreadView(int iBrdThreadView) Specifies the default view in which the messages are displayed in a page.
void	setEmailForwardPolicy(int iEmailForwardPolicy) Method specifying the policy email forwards for the outgoing emails from the board.
void	setEmailInboundPolicy(int iEmailInboundPolicy) Specifies the policy for the incoming email into the board.
void	setOriginalQuoted(boolean bQuoteOriginal) Sets if when building a reply message, the original message should be included as a quote.
void	setOutgoingDLEmailSubjectFormat(java.lang.String emailOutgoingDLSubjectFormat) Method specifying the default subject format for the outgoing emails from the board.
void	setOutgoingEmailDL(java.lang.String emailOutgoingDL) Method specifying the email address for the outgoing emails from the board.
void	setOutgoingEmailDLBodyFormat(java.lang.String emailOutgoingDLBodyFormat) Method specifying the default body format for the outgoing emails from the board.
void	setPublicAccessPolicy(int iPublicAccessPolicy) Sets the access policy of the board.
void	setReplyPrefix(java.lang.String replyPrefix) Sets the string to be prefixed to a message subject when building a reply (e.g.

Methods inherited from interface oracle.discussions.sdk.TdContainerSettings

currents, setDescription, setDisplayName, validate

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

REPLY_PREFIX

public static final java.lang.String REPLY_PREFIX

Specifies the prefix string to be applied to all the message replies sent from this board.

See Also:

Constant Field Values

REPLY_QUOTE_POLICY

public static final java.lang.String REPLY_QUOTE_POLICY

Specifies if the original message is to be appended as prefix string to the message replies sent from this board.

See Also:

Constant Field Values

REPLY_QUOTE_STRING

public static final java.lang.String REPLY_QUOTE_STRING

Specifies the quote string to be prefixed to the message replies sent from this board.

See Also:

Constant Field Values

EMAIL_INBOUND_POLICY

public static final java.lang.String EMAIL_INBOUND_POLICY

Specifies the inbound email policy for this board.

See Also:

Constant Field Values

EMAIL_INBOUND_NONE

public static final int EMAIL_INBOUND_NONE

Indicates that none of the incoming emails are posted as messages in the board.

See Also:

Constant Field Values

EMAIL_INBOUND_RESTRICTED

public static final int EMAIL_INBOUND_RESTRICTED

Indicates that incoming emails will be posted as messages into the board only if the sender plays a board writer or higher role.

See Also:

Constant Field Values

EMAIL_INBOUND_OPEN

public static final int EMAIL_INBOUND_OPEN

Indicates that all the incoming emails into the board are posted as messages into the board.

See Also:

Constant Field Values

EMAIL_FORWARD_POLICY

public static final java.lang.String EMAIL_FORWARD_POLICY

Specifies the email forwarding policy for this board.

See Also:

Constant Field Values

EMAIL_FWD_AS_ORIGINAL

public static final int EMAIL_FWD_AS_ORIGINAL

Indicates that messages posted to this board are forwarded as email messages only.

See Also:

Constant Field Values

EMAIL_FWD_AS_NOTIFICATION

public static final int EMAIL_FWD_AS_NOTIFICATION

Indicates that messages posted to this board are forwarded as notifications.

See Also:

Constant Field Values

THREAD_VIEW

public static final java.lang.String THREAD_VIEW

Specifies the default view of the messages displayed in a page.

See Also:

Constant Field Values

THREAD_VIEW_FLAT

public static final int THREAD_VIEW_FLAT

Indicates that the messages are displayed in a flat view.

See Also:

Constant Field Values

THREAD_VIEW_THREADED

public static final int THREAD_VIEW_THREADED

Indicates that the messages are displayed in threaded view.

See Also:

Constant Field Values

FLAT_VIEW_PAGING_SIZE

public static final java.lang.String FLAT_VIEW_PAGING_SIZE

Specifies the number of replies displayed per page in the flat view.

See Also:

Constant Field Values

CAN_ATTACH

public static final java.lang.String CAN_ATTACH

Specifies if the attachments are allowed for teh threads/messages posted in this board.

See Also:

Constant Field Values

MAX_ATTACH_SIZE

public static final java.lang.String MAX_ATTACH_SIZE

Specifies the maximum size of attachments that can be attached per thread/message.

See Also:

Constant Field Values

MESSAGE_EDIT_DELETE_POLICY

public static final java.lang.String MESSAGE_EDIT_DELETE_POLICY

Specifies the edit/hide policy for the messages posted into this board.

See Also:

Constant Field Values

NO_BOARD_EDIT_DELETE

public static final int NO_BOARD_EDIT_DELETE

Indicates that the messages posted into this board cannot be edited/deleted at all.

See Also:

Constant Field Values

BOARD_EDIT_DELETE_ONLY_NO_REPLY

public static final int BOARD_EDIT_DELETE_ONLY_NO_REPLY

Indicates that the messages posted into this board can be edited/deleted only if there are no replies posted to them.

See Also:

Constant Field Values

ALLOW_BOARD_EDIT_DELETE

public static final int ALLOW_BOARD_EDIT_DELETE

Indicates that the messages posted into this board can always be edited/deleted.

See Also:

Constant Field Values

PUBLIC_ACCESS_POLICY

public static final java.lang.String PUBLIC_ACCESS_POLICY

Specifies teh public access policy for this board.

See Also:

Constant Field Values

NO_PUBLIC_ACCESS

public static final int NO_PUBLIC_ACCESS

Indicates that the board is not publicly accessible. Only registered users can access the board.

See Also:

Constant Field Values

PUBLIC_ACCESS_WITHOUT_ANONYMOUS_POSTING

public static final int PUBLIC_ACCESS_WITHOUT_ANONYMOUS_POSTING

Indicates that the board is publicly acessible. But the guest users can only read the messages posted to the board. They cannot edit the threads/messages posted to the board.

See Also:

Constant Field Values

PUBLIC_ACCESS_WITH_ANONYMOUS_POSTING

public static final int PUBLIC_ACCESS_WITH_ANONYMOUS_POSTING

Indicates that the board is publicly acessible. Anyone can post messages to the board irrespective of their role in the board.

See Also:

Constant Field Values

BOARD_EMAIL_ADDRESS

public static final java.lang.String BOARD_EMAIL_ADDRESS

Specifies the board email address. Incoming emails into the board are designated to this address.

See Also:

Constant Field Values

BOARD_LOCKED

public static final java.lang.String BOARD_LOCKED

Specifies if the board is locked.

See Also:

Constant Field Values

COMPOSE_EDITOR

public static final java.lang.String COMPOSE_EDITOR

Specifies the editor to be used to compose threads/messages in the board.

See Also:

Constant Field Values

COMPOSE_EDITOR_PLAIN

public static final int COMPOSE_EDITOR_PLAIN

Indicates that the editor used is a plain text editor.

See Also:

Constant Field Values

COMPOSE_EDITOR_RICH

public static final int COMPOSE_EDITOR_RICH

Indicates that the editor used is a rich text editor.

See Also:

Constant Field Values

OUTGOING_EMAIL_DL

public static final java.lang.String OUTGOING_EMAIL_DL

Specifies the outgoing email address from the board. All the messages posted to this board will be forwarded to this email address depending on the board forwarding policy.

See Also:

Constant Field Values

OUTGOING_EMAIL_DL_SUBJECT_FORMAT

public static final java.lang.String OUTGOING_EMAIL_DL_SUBJECT_FORMAT

Specifies the outgoing email subject format.

See Also:

Constant Field Values

OUTGOING_EMAIL_DL_BODY_FORMAT

public static final java.lang.String OUTGOING_EMAIL_DL_BODY_FORMAT

Specifies the outgoing email body format.

See Also:

Constant Field Values

CLIP_POSTFIX

public static final java.lang.String CLIP_POSTFIX

Specifies the suffix to be added to the clipped messages in the board.

See Also:

Constant Field Values

Method Detail

getReplyPrefix

public java.lang.String getReplyPrefix()

Returns the string to be prefixed to a message subject when building a reply (e.g. "Re: ").

This prefix is set as a part of board settings.

Returns:

String

setReplyPrefix

public void setReplyPrefix(java.lang.String replyPrefix)

Sets the string to be prefixed to a message subject when building a reply (e.g. "Re: ").

This prefix is set as a part of board settings.

Parameters:

replyPrefix - the reply prefix set when specifying board settings.

isOriginalQuoted

public boolean isOriginalQuoted()
                         throws TdException

Returns true if when building a reply message, the original message should be included as a quote.

Used when replying with history.

Returns:

boolean

Throws:

TdException

setOriginalQuoted

public void setOriginalQuoted(boolean bQuoteOriginal)

Sets if when building a reply message, the original message should be included as a quote.

The original message quoted will be used when replying with history.

Parameters:

bQuoteOriginal - boolean value representing whether the original message is included or not if the boolean value is true, then the original message is included in the reply if the boolean value is false, then the original message is not included in the reply.

getBeginQuotePrefix

public java.lang.String getBeginQuotePrefix()

Returns the string to be used as a prefix when quoting a message. The string takes few tokens which will be processed by the system and replaced with the appropriate values according to the message being replied.

• {msg-sent-date} will be replaced with the sent date of the message being replied
• {msg-subject} will be replaced with the subject of the message being replied
• {msg-from} will be replaced with the email address of te sender
• {msg-author} will be replaced with the name of the sender

To escape a token, prefix the "{" with "\".

Returns:

String

setBeginQuotePrefix

public void setBeginQuotePrefix(java.lang.String beginQuotePrefix)

Sets the string to be used as a prefix when quoting a message.

Parameters:

beginQuotePrefix - the string used as a prefix when quoting a message

getBoardEditDeletePolicy

public int getBoardEditDeletePolicy()
                             throws TdException

Returns the policy defined specifying the message edit/delete settings in board. Board edit/delete policy should always be the same to keep system behaviour consistent. The board delete/edit policy defines the policy in place for the message editing/deleting in the board. It specifies three values. They are

• Never allow message editing or hiding - Once a message is posted, it is not allowed to edit/hide the same.
• Allow editing/hiding for messages with no replies - Only messages which are not replied to are allowed to be edited/hidden.
• Always allow message hiding/editing - No matter what, the message is always alowed to be edited/hidden.

• Returns:

  int

  Throws:

  TdException

  setBoardEditDeletePolicy

  public void setBoardEditDeletePolicy(int iBrdEditDeletePolicy)
                                throws TdException
  

  Specifies the policy for the message hide/edit in this board.

  Board edit/delete policy should always be the same to keep system behaviour consistent.
  The board delete/edit policy defines the policy in place for the message editing/deleting in the board.
  It specifies three values. They are
  

  • Never allow message editing or hiding - Once a message is posted, it is not allowed to edit/hide the same.
  • Allow editing/hiding for messages with no replies - Only messages which are not replied to are allowed to be edited/hidden.
  • Always allow message hiding/editin - No matter what, the message is always alowed to be edited/hidden.

  • Parameters:

    iBrdEditDeletePolicy - integer specifying the message hide/edit policy in the board.

    Throws:

    TdException

    getBoardThreadView

    public int getBoardThreadView()
                           throws TdException
    

    Returns the default view in place.

    There are two views currently supported. They are
    

    • Flat View - All messages of a topic are displayed on one page, sorted by time.
    • Threaded View - Used to view one message at a time in the topic. Users can select any message they wish to view in the topic. Messages in the topic are sorted in reply order.

    • Returns:

      int

      Throws:

      TdException

      setBoardThreadView

      public void setBoardThreadView(int iBrdThreadView)
                              throws TdException
      

      Specifies the default view in which the messages are displayed in a page.

      There are two views currently supported. They are
      

      • Flat View - All messages of a topic are displayed on one page, sorted by time.
      • Threaded View - Used to view one message at a time in the topic. Users can select any message they wish to view in the topic. Messages in the topic are sorted in reply order.

      • Parameters:

        iBrdThreadView - integer specifying the view

        Throws:

        TdException

        getBoardFlatViewPagingSize

        public int getBoardFlatViewPagingSize()
                                       throws TdException
        

        Returns the number of replies set per page.

        When the number of replies exceeds the number specified, then they are scrolled into the subsequent pages.

        Returns:

        int

        Throws:

        TdException

        setBoardFlatViewPagingSize

        public void setBoardFlatViewPagingSize(int iBrdFlatViewPagingSize)
                                        throws TdException
        

        Specifies the number of replies to be displayed at a time in a page.

        When the number of replies exceeds the number specified, then they are scrolled into the subsequent pages.

        Parameters:

        iBrdFlatViewPagingSize - integer representing the number of replies in a page.

        Throws:

        TdException

        setBoardEmail

        public void setBoardEmail(java.lang.String boardEmail)
                           throws TdException
        

        Specifies teh board email address.

        Board email is specified when the board is being created.
        The incoming messages into the board fromt he email clients will be designated to this email address.
        Should be specified at the board creation time, since board email alias is used in every mesage stored in the board.
        

        Parameters:

        boardEmail - the email address set to the board.

        Throws:

        TdException

        getBoardEmail

        public java.lang.String getBoardEmail()
                                       throws TdException
        

        Returns the email address of the board.

        Board email is specified when the board is being created.
        The incoming messages into the board fromt he email clients will be designated to this email address.
        

        Returns:

        String

        Throws:

        TdException

        isLocked

        public boolean isLocked()
                         throws TdException
        

        Returns a boolean value representing if a board is locked.

        Once a board is locked, only board moderators and administrators can post messages to the board.
        A board will be locked when a moderator/administrator wants to take the board offline, preventing access from other users.
        The return value is true if the board is locked and false otherwise.
        

        Returns:

        boolean.

        Throws:

        TdException

        lock

        public void lock(boolean bLocked)
        

        Locks the board if the boolean argument passed is true.

        Once a board is locked, only board moderators and administrators can post messages to the board.
        A board will be locked when a moderator/administrator wants to take the board offline, preventing access from other users.
        

        Parameters:

        bLocked - boolean value indicating whether the board is to be locked.

        getEmailInboundPolicy

        public int getEmailInboundPolicy()
                                  throws TdException
        

        Returns the email inbound policy in place for the board.

        Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. Messages posted from the email client, will be placed as messages in the board.
        Currently thread information is not supported for these messages.
        The incoming email policy specifies three configurations. They are
        

        • Ignore All - All the emails posted from the email clients coming into the board are discarded. None of them is posted as a message into the board.
        • Restricted - Emails coming in from the email client are posted as messages to the board, only if the email sender has a board writer privilege on this board.
        • Open - All the emails incoming into this board are posted as messages in the board.

        • Returns:

          int

          Throws:

          TdException

          setEmailInboundPolicy

          public void setEmailInboundPolicy(int iEmailInboundPolicy)
                                     throws TdException
          

          Specifies the policy for the incoming email into the board.

          Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. Messages posted from the email client, will be placed as messages in the board.
          Currently thread information is not supported for these messages.
          The incoming email policy specifies three configurations. They are
          

          • Ignore All - All the emails posted from the email clients coming into the board are discarded. None of them is posted as a message into the board.
          • Restricted - Emails coming in from the email client are posted as messages to the board, only if the email sender has a board writer privilege on this board.
          • Open - All the emails incoming into this board are posted as messages in the board.

          • Parameters:

            iEmailInboundPolicy - integer specifying the incoming email policy.

            Throws:

            TdException

            getEmailForwardPolicy

            public int getEmailForwardPolicy()
                                      throws TdException
            

            Returns the email forward policy in place.

            Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
            Currently thread information is not supported for these messages.
            When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
            There are two email forwarding policies. They are
            

            • Do not forward any message - None of the posted messages will be forwarded to any email address, though they are specified.
            • Forward all messages to the following email address - All the posted messaegs will be forwarded to the specified email address, if specified. If email address is not specified, TdException is thrown.

              Throws:

              TdException.

              TdException

              setEmailForwardPolicy

              public void setEmailForwardPolicy(int iEmailForwardPolicy)
                                         throws TdException
              

              Method specifying the policy email forwards for the outgoing emails from the board.

              Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
              Currently thread information is not supported for these messages.
              When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
              There are two email forwarding policies. They are
              

              • Do not forward any message - None of the posted messages will be forwarded to any email address, though they are specified.
              • Forward all messages to the following email address - All the posted messaegs will be forwarded to the specified email address, if specified. If email address is not specified, TdException is thrown.

                Parameters:

                iEmailForwardPolicy - integer specifying the email forward policy.

                Throws:

                TdException.

                TdException

                getOutgoingEmailDL

                public java.lang.String getOutgoingEmailDL()
                                                    throws TdException
                

                Returns the text representing the email address for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Returns:

                String

                Throws:

                TdException.

                TdException

                setOutgoingEmailDL

                public void setOutgoingEmailDL(java.lang.String emailOutgoingDL)
                                        throws TdException
                

                Method specifying the email address for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Parameters:

                emailOutgoingDL - text indicating the email address of the outgoing emails from the board.

                Throws:

                TdException.

                TdException

                getOutgoingEmailDLSubjectFormat

                public java.lang.String getOutgoingEmailDLSubjectFormat()
                                                                 throws TdException
                

                Returns the text representing the subject format for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Returns:

                String

                Throws:

                TdException.

                TdException

                setOutgoingDLEmailSubjectFormat

                public void setOutgoingDLEmailSubjectFormat(java.lang.String emailOutgoingDLSubjectFormat)
                                                     throws TdException
                

                Method specifying the default subject format for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Parameters:

                emailOutgoingDLSubjectFormat - text indicating the subject of the outgoing emails from the board.

                Throws:

                TdException.

                TdException

                getOutgoingEmailDLBodyFormat

                public java.lang.String getOutgoingEmailDLBodyFormat()
                                                              throws TdException
                

                Returns the text representing the body format for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Returns:

                String

                Throws:

                TdException.

                TdException

                setOutgoingEmailDLBodyFormat

                public void setOutgoingEmailDLBodyFormat(java.lang.String emailOutgoingDLBodyFormat)
                                                  throws TdException
                

                Method specifying the default body format for the outgoing emails from the board.

                Oracle discussions supports integration of the boards with the email clients, so that messages can be sent/received from/to the email client to the board. They are processed and are posted as messages in the board.
                Currently thread information is not supported for these messages.
                When an outgoing email address is specified and if the outgoing email policy is specified to forward the message to that email id, then the messages posted to the board are forwarded to the same.
                

                Parameters:

                emailOutgoingDLBodyFormat - default body format for the messages posted to the board, which are forwarded to the external email address.

                Throws:

                TdException.

                TdException

                getBoardCanAttach

                public boolean getBoardCanAttach()
                                          throws TdException
                

                Returns a boolean value indicating whether the attachments are allowed or not.

                A true value indicates that the attachments are allowed and a false value indicates that they are not.
                If the attachments are not allowed, then the methods setBoardAttachmentMaxSize(int), getBoardAttachmentMaxSize() throw TdException when invoked.
                

                Returns:

                boolean

                Throws:

                TdException.

                TdException

                setBoardCanAttach

                public void setBoardCanAttach(boolean bCanAttach)
                                       throws TdException
                

                Specifies a boolean value indicating wheter attachments in this board to threads/messages are allowed.

                A true value indicates that the attachments are allowed and a false value indicates that they are not.
                If the attachments are not allowed, then the methods setBoardAttachmentMaxSize(int), getBoardAttachmentMaxSize() throw TdException when invoked.
                

                Parameters:

                bCanAttach - boolean variable indicating whether attachments are allowed or not.

                Throws:

                TdException.

                TdException

                getBoardAttachmentMaxSize

                public int getBoardAttachmentMaxSize()
                                              throws TdException
                

                Returns the maximum attachment size per thread/message.

                The size is expected to be specified in kilo bytes.
                If specified, attachments greater than the specified size are rejected, when tried to be attached.
                

                Returns:

                int

                Throws:

                TdException

                setBoardAttachmentMaxSize

                public void setBoardAttachmentMaxSize(int iAttachmentMaxSize)
                                               throws TdException
                

                Defines the maximum size of the attachments allowed per thread/message.

                The size is expected to be specified in kilo bytes.
                If specified, attachments greater than the specified size are rejected, when tried to be attached.
                

                Parameters:

                iAttachmentMaxSize - integer representing the attachments max size.

                Throws:

                TdException

                getBoardComposeEditor

                public int getBoardComposeEditor()
                                          throws TdException
                

                Returns the editor policy in place.

                Two types of editors are supported. They are
                

                • Rich Text Editor - Includes controls to edit the font,color,weight and other properties of the test typed.
                • Plain Text Editor - An editor just like notepad without advanced features.

                • Returns:

                  int

                  Throws:

                  TdException.

                  TdException

                  setBoardComposeEditor

                  public void setBoardComposeEditor(int iBrdComposeEditor)
                                             throws TdException
                  

                  Defines the default editor to be used for posting threads/messages in the board.

                  Two types of editors are supported. They are
                  

                  • Rich Text Editor - Includes controls to edit the font,color,weight and other properties of the test typed.
                  • Plain Text Editor - An editor just like notepad without advanced features.

                  • Parameters:

                    iBrdComposeEditor - integer defining the editor policy.

                    Throws:

                    TdException.

                    TdException

                    getPublicAccessPolicy

                    public int getPublicAccessPolicy()
                                              throws TdException
                    

                    Returns the board access policy in place.

                    Public access policy of a board defines the access restriction on who can access the board.
                    It can accomodiate three values. They are
                    

                    • Do not allow public access - Only the members who are registered with teh forum are allowed to access the forum.
                    • Enable public access without anonymous posting - (Guest Users)Anonymous users are not allowed to post messages into the board.
                    • Enable public access with anonymous posting - (Guest Users)Anonymous users are also allowed to post messages into the board.

                    • Returns:

                      int

                      Throws:

                      TdException

                      setPublicAccessPolicy

                      public void setPublicAccessPolicy(int iPublicAccessPolicy)
                                                 throws TdException
                      

                      Sets the access policy of the board.

                      Public access policy of a board defines the access restriction on who can access the board.
                      It can accomodiate three values. They are
                      

                      • Do not allow public access - Only the members who are registered with teh forum are allowed to access the forum.
                      • Enable public access without anonymous posting - (Guest Users)Anonymous users are not allowed to post messages into the board.
                      • Enable public access with anonymous posting - (Guest Users)Anonymous users are also allowed to post messages into the board.

                      • Parameters:

                        iPublicAccessPolicy - integer defining the access policy

                        Throws:

                        TdException