org.netbeans.lib.collab
Interface NewsChannel

All Superinterfaces:
Conference

public interface NewsChannel
extends Conference

NewsChannels inherit all the attributes and behaviors of a conference, in particular, members can be instantly notified of new messages, access control rules are created and manages the same way.

However, An instant bulletin board differs from a public conference in the following ways.

Since:
version 0.1

Field Summary
 
Fields inherited from interface org.netbeans.lib.collab.Conference
INVITE, LISTEN, MANAGE, NONE, PUBLISH, STATUS_APPROVED, STATUS_MODIFIED, STATUS_PENDING, STATUS_REJECTED, STATUS_SUBMIT
 
Method Summary
 void getMessages()
          retrieves all the messages posted to the newschannel.
 void modifyMessage(java.lang.String messageId, Message message)
          modify a message from the bulletin board
 void removeMessage(java.lang.String MessageId)
          remove a message from the bulletin board
 void setListener(NewsChannelListener listener)
          set listener to the newschannel.
 void subscribe(NewsChannelListener listener)
          subscribe to a bulletin board.
 
Methods inherited from interface org.netbeans.lib.collab.Conference
addMessage, addModeratedMessage, close, createInviteMessage, createMessage, getDefaultPrivilege, getDestination, getDisplayName, getEventMask, getParticipants, getPrivilege, getPrivilege, getProperty, hasPrivilege, invite, isPublic, join, join, leave, listPrivileges, moderate, save, setDefaultPrivilege, setDisplayName, setEventMask, setPrivilege, setPrivileges, setProperty
 

Method Detail

removeMessage

public void removeMessage(java.lang.String MessageId)
                   throws CollaborationException
remove a message from the bulletin board

Parameters:
MessageId - id of the message to remove
Throws:
CollaborationException

modifyMessage

public void modifyMessage(java.lang.String messageId,
                          Message message)
                   throws CollaborationException
modify a message from the bulletin board

Parameters:
messageId - messageID message id
message - the modified message.
Throws:
CollaborationException

subscribe

public void subscribe(NewsChannelListener listener)
               throws CollaborationException
subscribe to a bulletin board.

Parameters:
listener - the listener by which modifications to the bulletin board are conveyed asynchronously to the caller.
Throws:
CollaborationException

setListener

public void setListener(NewsChannelListener listener)
                 throws CollaborationException
set listener to the newschannel. This method should be invoked for all the subscribed newschannels to be able to receive newschannel notifications asynchronously.

Parameters:
listener - the listener by which notifications are conveyed asynchronously to the caller.
Throws:
CollaborationException

getMessages

public void getMessages()
                 throws CollaborationException
retrieves all the messages posted to the newschannel. The news messages are notified asynchronously using the callback methods of the NewsChannelListener You have to invoke setListener before invoking this method to be able to receive the news messages posted to the newschannel.

Throws:
CollaborationException