oracle.workspaces.resource.discussion
Class CwBoardDefinition

java.lang.Object
oracle.workspaces.resource.CwResourceItemDefinition
oracle.workspaces.resource.discussion.CwBoardDefinition

public class CwBoardDefinition

extends CwResourceItemDefinition

Definition object used to create a new CwBoard. Definition objects contain user-assignable properties and lack Uids.

Since:

release specific (what release of product did this appear in)

Constructor Summary

CwBoardDefinition(java.lang.String szBoardName, java.lang.String szBoardDisplayName)
Constructor for a new board definition object.

CwBoardDefinition(java.lang.String szBoardName, java.lang.String szBoardDisplayName, java.lang.String szEmailAddress)
Constructor for a new board definition object.

Method Summary

java.lang.String	getBeginQuotePrefix() Returns the board setting for BeginQuotePrefix.
int	getBoardEditDeletePolicy() Returns the board setting for BoardEditPolicy.
java.lang.String	getDisplayName() Gets display name for the board.
java.lang.String	getEmailAddress() Returns the board email address, or null if not email-enabled.
int	getEmailInboundPolicy() Returns the board setting for BoardEmailInboundPolicy.
java.lang.String	getSubjectReplyPrefix() Returns the board setting for SubjectReplyPrefix.
boolean	isOriginalQuoted() Returns the board setting for isOriginalQuoted.
void	setBeginQuotePrefix(java.lang.String szBeginQuotePrefix) Sets the board setting for BeginQuotePrefix.
void	setBoardEditDeletePolicy(int iBoardEditDeletePolicy) Sets the board setting for BoardEditPolicy.
void	setDescription(java.lang.String desc) Sets description for the resource item.
void	setDisplayName(java.lang.String displayName) Sets display name for the board.
void	setEmailAddress(java.lang.String szEmailAddress) Sets the board email address.
void	setEmailInboundPolicy(int iBoardEmailInboundPolicy) Sets the board setting for BoardEmailInboundPolicy.
void	setOriginalQuoted(boolean bOriginalQuoted) Sets the board setting for isOriginalQuoted.
void	setSubjectReplyPrefix(java.lang.String szSubjectReplyPrefix) Sets the board setting for SubjectReplyPrefix.

Methods inherited from class oracle.workspaces.resource.CwResourceItemDefinition

getDescription, getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CwBoardDefinition

public CwBoardDefinition(java.lang.String szBoardName,
                         java.lang.String szBoardDisplayName)

Constructor for a new board definition object. Note that this board will not be email-enabled. The board email address can be set at a later time (once only) to email-enable the board.

Parameters:

szBoardName - the unique name of the board

szBoardDisplayName - the user-friendly name of the board

CwBoardDefinition

public CwBoardDefinition(java.lang.String szBoardName,
                         java.lang.String szBoardDisplayName,
                         java.lang.String szEmailAddress)

Constructor for a new board definition object. Note that a null email address will result in creation of a non-email-enabled board. The email address can be set later (once only).

Parameters:

szBoardName - the unique name of the board

szBoardDisplayName - the user-friendly name of the board

szEmailAddress - the email address for posting to the board via email

Method Detail

getBeginQuotePrefix

public java.lang.String getBeginQuotePrefix()

Returns the board setting for BeginQuotePrefix.

getBoardEditDeletePolicy

public int getBoardEditDeletePolicy()

Returns the board setting for BoardEditPolicy. Note: The valid values are public constants in the CwBoard class.

getDisplayName

public java.lang.String getDisplayName()
                                throws CwAttrValException

Gets display name for the board.

Throws:

CwAttrValException

getEmailAddress

public java.lang.String getEmailAddress()

Returns the board email address, or null if not email-enabled.

getEmailInboundPolicy

public int getEmailInboundPolicy()

Returns the board setting for BoardEmailInboundPolicy. Note: The valid values are public constants in the CwBoard class.

getSubjectReplyPrefix

public java.lang.String getSubjectReplyPrefix()

Returns the board setting for SubjectReplyPrefix.

isOriginalQuoted

public boolean isOriginalQuoted()

Returns the board setting for isOriginalQuoted.

setBeginQuotePrefix

public void setBeginQuotePrefix(java.lang.String szBeginQuotePrefix)

Sets the board setting for BeginQuotePrefix.

setBoardEditDeletePolicy

public void setBoardEditDeletePolicy(int iBoardEditDeletePolicy)
                              throws CwAttrValException

Sets the board setting for BoardEditPolicy. Note: The valid values are public constants in the CwBoard class.

Throws:

CwAttrValException

setDescription

public void setDescription(java.lang.String desc)
                    throws CwAttrValException

Sets description for the resource item.

Overrides:

setDescription in class CwResourceItemDefinition

Throws:

CwAttrValException

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws CwAttrValException

Sets display name for the board.

Throws:

CwAttrValException

setEmailAddress

public void setEmailAddress(java.lang.String szEmailAddress)

Sets the board email address. Note that this can only be done and committed a single time, either during board creation of afterward. Any attempt to reset the email address to a different value will throw an exception upon storeProperties().

setEmailInboundPolicy

public void setEmailInboundPolicy(int iBoardEmailInboundPolicy)
                           throws CwAttrValException

Sets the board setting for BoardEmailInboundPolicy. Note: The valid values are public constants in the CwBoard class.

Throws:

CwAttrValException

setOriginalQuoted

public void setOriginalQuoted(boolean bOriginalQuoted)

Sets the board setting for isOriginalQuoted.

setSubjectReplyPrefix

public void setSubjectReplyPrefix(java.lang.String szSubjectReplyPrefix)

Sets the board setting for SubjectReplyPrefix.