com.jivesoftware.forum.mail
Interface EmailAction

All Known Implementing Classes:

CreateThread, ReplyToThread

public interface EmailAction

Command interface representing actions that result from incoming email messages. Used by EmailMonitor to respond to incoming email. These are one-shot objects which just insulate EmailMonitor from details of what specific actions to take once an email has been accepted.

See Also:

EmailMonitor

Method Summary

void	execute() Executes the command represented by this instance.
long	getActingUserID() Returns the id of the user this instance will act as.
long	getTargetObjectID() Returns the id of the object this action will act on.
int	getTargetObjectType() Returns the type of object this action will act on.

Method Detail

execute

void execute()
             throws EmailMonitorException

Executes the command represented by this instance.

Throws:

EmailMonitorException - if command execution fails

getActingUserID

long getActingUserID()

Returns the id of the user this instance will act as. For example, if this action creates a message, the return value of this method would be the user id of the resultant message's author.

Returns:

the id of the user this instance will act as.

getTargetObjectType

int getTargetObjectType()

Returns the type of object this action will act on. The value will be one of the constants in JiveConstants. Note this is not necessarily the type of object that will be created - it is the type of object which will be modified. For example, if this action created a new thread, the object type would be JiveConstants.FORUM, and getTargetObjectID() would return the id of the forum in which the thread would be created.

Returns:

the type of object this action will act on.

getTargetObjectID

long getTargetObjectID()

Returns the id of the object this action will act on. For example, if this action created a new thread, the object id would be the the id of the forum in which the thread would be created.

Returns:

the type of object this action will act on.