|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
oracle.discussions.sdk.TdContainer | +--oracle.discussions.sdk.TdBoard
This class represents a Board for holding messages. Board can only contain messages.
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.
Field Summary | |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsAppendMessage |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsDelete |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsEditMessage |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsEraseMessages |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGetLastPost |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGetThread |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGetThreads |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantBoardModerator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantBoardReader |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantBoardWriter |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsLock |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsMarkPublic |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeBoardModerator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeBoardReader |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeBoardWriter |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsUnlock |
protected static oracle.dms.instrument.Noun |
s_nBoard |
protected static java.lang.String |
s_processRequest |
Constructor Summary | |
TdBoard(oracle.mail.sdk.esmail.OracleStore admstore, oracle.mail.sdk.esmail.OracleStore usrstore, oracle.discussions.sdk.impl.TdSession tdsession, java.lang.String folderName, long lFolderId, java.lang.String nameSpace) Constructor to build a tdboard instance. |
Method Summary | |
TdMessage |
appendMessage(javax.mail.Message mm) Appends the supplied messages to this Board. |
void |
convertUserFlag(javax.mail.Flags flags, long lUsrFlags) Converts user flags as per the long flags number passed. |
javax.mail.internet.MimeMessage |
createMessageForEdit(TdMessage msgOrig) Replicates the original message for editing purpose. |
javax.mail.internet.MimeMessage |
createMessageReply(TdMessage msgOrig) Creates a message for the reply of the supplied one. |
javax.mail.internet.MimeMessage |
createMessageReply(TdMessage msgOrig, boolean htmlContentType) Creates a message for the reply of the supplied one. |
javax.mail.internet.MimeMessage |
createMessageReply(TdMessage msgOrig, boolean htmlContentType, java.util.Locale loc, java.util.TimeZone tz) Creates a message for the reply of the supplied one. |
javax.mail.internet.MimeMessage |
createMessageTopic() Creates a message for a new topic under this board. |
javax.mail.internet.MimeMessage |
createMessageTopic(java.util.Locale loc) Creates a message for a new topic under this board. |
void |
delete() Deletes this TdFacility in this message store - child facilities boards and messages will be deleted too. |
TdMessage |
editMessage(TdMessage origMsg, javax.mail.Message mm) Edits the given message and rturns back the edited message. |
void |
eraseMessages(TdMessage[] msgs) Erases the messages from the current board. |
TdBoardSettings |
getBoardSettings() Returns the settings of the board. |
TdBoardSettings |
getBoardSettings(boolean bRefresh) Returns the settings of the board. |
int |
getContainerType() Returns the container type. |
TdLastPost |
getLastPost() Returns information on the last message posted to this board. |
int |
getMessageCount() Returns the count of messages in the board. |
int |
getNewMessageCount() Returns the count of the new messages in the board. |
TdThread |
getThread(int iThreadId) Returns the Thread from the current board, given its ID. |
int |
getThreadCount() Returns the count of threads in the board. |
TdIterator |
getThreads() Returns the list of message threads available in this board. |
TdIterator |
getThreads(int iFetchStart, boolean bSortByCreation, boolean bAscending) Returns the list of message threads available in this board. |
int |
getUnreadMessageCount() Returns the number of messages which are unread in the board. |
void |
grantBoardModerator(TdUser tdUser) Grants Board Moderator role to the supplied user for this board. |
void |
grantBoardReader(TdUser tdUser) Grants Board Reader role to the supplied user for this board. |
void |
grantBoardWriter(TdUser tdUser) Grants Board Writer role to the supplied user for this board. |
boolean |
hasNewMessages() Returns a boolean value indicating if the board has new messages. |
boolean |
isLocked() Returns the boolean status indicating if the board is locked. |
boolean |
isPublic() Returns a boolean value indicating if the board is public. |
void |
lock() Locks the oracle discussions board. |
void |
revokeBoardModerator(TdUser tdUser) Revokes Board Moderator role to the supplied user for this board. |
void |
revokeBoardReader(TdUser tdUser) Revokes Board Reader role to the supplied user for this board. |
void |
revokeBoardWriter(TdUser tdUser) Revokes Board Writer role to the supplied user for this board. |
void |
unlock() Unlocks the oracle discussions board. |
Field Detail |
protected static oracle.dms.instrument.Noun s_nBoard
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsDelete
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsAppendMessage
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsEditMessage
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsEraseMessages
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetLastPost
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetThread
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetThreads
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantBoardModerator
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantBoardWriter
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantBoardReader
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeBoardModerator
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeBoardWriter
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeBoardReader
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsLock
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsUnlock
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsMarkPublic
protected static java.lang.String s_processRequest
Constructor Detail |
public TdBoard(oracle.mail.sdk.esmail.OracleStore admstore, oracle.mail.sdk.esmail.OracleStore usrstore, oracle.discussions.sdk.impl.TdSession tdsession, java.lang.String folderName, long lFolderId, java.lang.String nameSpace)
admstore
- Oracle email administrator storeusrstore
- Oracle email User storetdsession
- oracle discussions sessionfolderName
- name of the board to be created.lFolderId
- long folder identifier indicating the shared folder.nameSpace
- the email store namespace in whic folder is created.Method Detail |
public int getContainerType()
Returns TdContainer.TD_BOARD.
public TdLastPost getLastPost() throws TdException
public void grantBoardModerator(TdUser tdUser) throws TdException
tdUser
- oracle discussions user to whom the role is to be granted.public boolean isPublic() throws TdException
Returns true if the board is public and false otherwise.
public void grantBoardReader(TdUser tdUser) throws TdException
tdUser
- user to whom board reader permissions is to be granted.public void grantBoardWriter(TdUser tdUser) throws TdException
tdUser
- to whom board writer role to whom board writer role is to be granted.public void revokeBoardModerator(TdUser tdUser) throws TdException
tdUser
- user from whom board moderator role is being revoked.public void revokeBoardReader(TdUser tdUser) throws TdException
tdUser
- user from whom board rader role is being revoked frompublic void revokeBoardWriter(TdUser tdUser) throws TdException
tdUser
- discussions user from whom board writer role is being revokedpublic javax.mail.internet.MimeMessage createMessageTopic() throws TdException
The returned message is NOT appended to the board. The returned message will be initialized according to the board settings and teh connect user:
public javax.mail.internet.MimeMessage createMessageTopic(java.util.Locale loc) throws TdException
The returned message is NOT appended to the board. The returned message will be initialized according to the board settings and teh connect user:
loc
- locale information to be used to format the author namepublic javax.mail.internet.MimeMessage createMessageReply(TdMessage msgOrig) throws TdException, javax.mail.MessagingException
The returned message is NOT appended to the board. The returned message will be initialized according to the board settings:
msgOrig
- original message to which reply is to be createdpublic javax.mail.internet.MimeMessage createMessageReply(TdMessage msgOrig, boolean htmlContentType) throws TdException, javax.mail.MessagingException
The returned message is NOT appended to the board. The returned message will be initialized according to the board settings:
msgOrig
- original message to which reply is to be createdhtmlContentType
- content type used in creating the message.public javax.mail.internet.MimeMessage createMessageReply(TdMessage msgOrig, boolean htmlContentType, java.util.Locale loc, java.util.TimeZone tz) throws TdException, javax.mail.MessagingException
The returned message is NOT appended to the board. The returned message will be initialized according to the board settings:
msgOrig
- original message to which reply is to be createdhtmlContentType
- content type to be used in the replyloc
- locale information to be used to format the reply.tz
- the time zone to be used to format the reply prefixpublic javax.mail.internet.MimeMessage createMessageForEdit(TdMessage msgOrig) throws TdException, javax.mail.MessagingException
msgOrig
- Original message to be editedpublic TdMessage editMessage(TdMessage origMsg, javax.mail.Message mm) throws TdException, javax.mail.MessagingException
origMsg
- original message to be editedmm
- message to be added to the original msgpublic TdMessage appendMessage(javax.mail.Message mm) throws TdException, javax.mail.MessagingException
mm
- message to be appendedpublic TdBoardSettings getBoardSettings() throws TdException
public TdBoardSettings getBoardSettings(boolean bRefresh) throws TdException
bRefresh,
- refresh board settings when set to truepublic void eraseMessages(TdMessage[] msgs) throws javax.mail.MessagingException, TdException
msgs
- array of messages to be erased.public int getThreadCount() throws TdException
public int getMessageCount() throws javax.mail.MessagingException
public int getNewMessageCount() throws javax.mail.MessagingException
A message is considered as new if the user hasnot already read the same.
public boolean hasNewMessages() throws javax.mail.MessagingException
A message is considered as new if the user hasnot already read the same.
Returns true is the message is new and false otherwise.
public TdThread getThread(int iThreadId) throws TdException, javax.mail.MessagingException
iThreadId
- the thread id indicating thread retrievedpublic TdIterator getThreads() throws TdException
TdThread objects are light-weight references to the actual message that started the thread. In addition to the message id of the thread in this call thread information such # of messages in the Thread and last post information (date, author) will be retrieved too. To fill up additional thread details call fetch.
By default threads will be sorted by last post date in descending order.
public TdIterator getThreads(int iFetchStart, boolean bSortByCreation, boolean bAscending) throws TdException
TdThread objects are light-weight references to the actual message that started the thread. In addition to the message id of the thread in this call thread information such # of messages in the Thread and last post information (date, author) will be retrieved too.
To fill up additional thread details call fetch. Limiting Sorting options can be specified too.
By default threads will be sorted by last post date in descending order.
iFetchStart
- number of threads to be fetched.bSortByCreation
- boolean condition indicating if the threads are to be sorted by creation timebAscending
- boolean condition indicating the order in which the threads are sorted.public int getUnreadMessageCount() throws javax.mail.MessagingException
public void lock() throws TdException
public void unlock() throws TdException
public boolean isLocked() throws TdException
Returns true if the board is locked, false otherwise.
public void delete() throws TdException
public void convertUserFlag(javax.mail.Flags flags, long lUsrFlags) throws javax.mail.MessagingException
Checks in the array of glags if all the flags are set, if not, sets the same.
flags
- The flags that are setlUsrFlags
- long value which is used in comparing ans setting the flags.
|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |