Available Workflow Event Descriptors > Class EMailEventDescriptor

Class EMailEventDescriptor

public class 
net.juniper.smgt.net.juniper.smgt.workflow.engine.adapters.EMailEvent

Descriptorextends 
net.juniper.smgt.net.juniper.smgt.workflow.engine.EventDescriptor

This event descriptor holds the information that allows the E-mail Adapter to properly generate events to the interested work items. The adapter uses a set of key-value pairs to decide which work items it sends an event to when an e-mail is received. A descriptor is created when a message has been parsed.

The criterion is the session information encapsulated in an e-mail message; that is, the InputParameters of a Send Email work item.

The result is the information that is expected back; that is, the OutputParameters of both e-mail work items.

The adapter then tries to match this event with the descriptors provided by the work items. When a match is made, the event is sent to the source of the event descriptors. More than one match can be made. A copy of the event will be sent to each work item that provided a matching event descriptor.

 Constructor Detail

 EMailEventDescriptor
 public EMailEventDescriptor()


 Method Detail

 addCriteria
public void addCriteria(java.lang.String key,
                        java.lang.String value)

 Adds new criteria. The key is the name of the parameter, and the value is its value as in the session information in the message.
 Parameters:
Key - java.lang.String
Value - java.lang.String
 
 getCriteria
public java.util.Properties getCriteria()

 Returns the set of criteria embedded in the event descriptor.
Returns: java.util.Properties
 
 getResult
public java.lang.String getResult(java.lang.String key)

 Get a result parameter given its name.
Returns: java.lang.String[]