| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
| Method Summary | |
|  void | addPart(MessagePart part)adds a body part to the end of the message being built | 
|  MessageProcessingRule | addProcessingRule(int index,
                  MessageProcessingRule.Condition condition,
                  MessageProcessingRule.Action action)insert a message processing rule at the given position rules are to be processed by the service in the order in which they are specified, until one matches. | 
|  MessageProcessingRule | addProcessingRule(MessageProcessingRule.Condition condition,
                  MessageProcessingRule.Action action)adds a message processing rule at the end of the rule set. | 
|  void | addRecipient(java.lang.String destination)adds a recipient to a message | 
|  java.util.Date | getExpirationDate()returns the date of expiration of this message. | 
|  java.lang.String | getHeader(java.lang.String header)get the value of a header | 
|  java.lang.String | getMessageId()returns the message identifier. | 
|  java.lang.String | getOriginator()returns the originator address | 
|  MessagePart[] | getParts()get the nested parts of a multi-part message or message part | 
|  java.lang.String[] | getRecipients()get the recipients of the message. | 
|  MessagePart | newPart()instantiates a new body part. | 
|  void | removePart(MessagePart part)removes a bodypart | 
|  MessageProcessingRule | removeProcessingRule(int index)removes a message processing rule. | 
|  boolean | removeProcessingRule(MessageProcessingRule rule)removes a message processing rule. | 
|  void | removeRecipient(java.lang.String destination)removes a recipient from the recipient list of a message. | 
|  void | sendReply(Message message)send a reply to the alert message | 
|  void | sendStatus(int status)acknowledge reception of the message | 
|  void | setExpirationDate(java.util.Date expireAt)Deprecated. use addProcessingRule | 
|  void | setHeader(java.lang.String header,
          java.lang.String value)set the value of a header | 
|  void | setOriginator(java.lang.String originator)returns the originator address | 
| Methods inherited from interface org.netbeans.lib.collab.MessagePart | 
| clearContent, setContent, setContent, setContent, setContent, setContentName, setContentType | 
| Methods inherited from interface org.netbeans.lib.collab.ReadOnlyMessagePart | 
| getBytes, getContent, getContent, getContentEncoding, getContentID, getContentName, getContentType, getInputStream, getSize | 
| Method Detail | 
public void sendStatus(int status)
                throws CollaborationException
status - as defined in MessageStatus
CollaborationExceptionMessageStatus
public void sendReply(Message message)
               throws CollaborationException
message - reply message.  The reply message must be implemented with the
 createReply method.
CollaborationExceptionpublic java.lang.String getOriginator()
public void setOriginator(java.lang.String originator)
                   throws CollaborationException
CollaborationException
public void addRecipient(java.lang.String destination)
                  throws CollaborationException
destination - recipient's address
CollaborationException
public void removeRecipient(java.lang.String destination)
                     throws CollaborationException
destination - recipient's address
CollaborationException
public java.lang.String[] getRecipients()
                                 throws CollaborationException
CollaborationExceptionpublic java.lang.String getMessageId()
public java.util.Date getExpirationDate()
public MessagePart newPart()
                    throws CollaborationException
CollaborationExceptionaddPart(org.netbeans.lib.collab.MessagePart)public java.lang.String getHeader(java.lang.String header)
public void setHeader(java.lang.String header,
                      java.lang.String value)
               throws CollaborationException
CollaborationException
public void addPart(MessagePart part)
             throws CollaborationException
part - message bodypart to add.
CollaborationException
public void removePart(MessagePart part)
                throws CollaborationException
part - Message Part tp remove.
CollaborationExceptionpublic MessagePart[] getParts()
public void setExpirationDate(java.util.Date expireAt)
                       throws CollaborationException
expireAt - date at which the message will expire
CollaborationException
public MessageProcessingRule addProcessingRule(MessageProcessingRule.Condition condition,
                                               MessageProcessingRule.Action action)
                                        throws ServiceUnavailableException,
                                               java.lang.IllegalArgumentException
condition - matching condition for this ruleaction - what to do if the condition is matched
ServiceUnavailableException - the service does not support
 user-controlled message processing or does not support the specific
 action/condition combination provided
java.lang.IllegalArgumentException - if the condition or action is null
public MessageProcessingRule addProcessingRule(int index,
                                               MessageProcessingRule.Condition condition,
                                               MessageProcessingRule.Action action)
                                        throws ServiceUnavailableException,
                                               java.lang.IndexOutOfBoundsException,
                                               java.lang.IllegalArgumentException
index - position of the rule within the rule set.  Order
 of rule matters since they are applied sequentially until a 
 match is found.condition - matching condition for this ruleaction - what to do if the condition is matched
ServiceUnavailableException - the service does not support
 user-controlled message processing.
java.lang.IndexOutOfBoundsException - if the index is out of range
java.lang.IllegalArgumentException - if the condition or action is nullpublic boolean removeProcessingRule(MessageProcessingRule rule)
rule - the rule to remove
public MessageProcessingRule removeProcessingRule(int index)
                                           throws java.lang.IndexOutOfBoundsException
index - position of the rule to remove
java.lang.IndexOutOfBoundsException| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||