com.jcorporate.expresso.core.misc
Class EventQueueEntry

java.lang.Object
  com.jcorporate.expresso.core.misc.EventQueueEntry

public class EventQueueEntry

extends Object

Event queue entry class represents a unit of work for the event handler thread.

NB: Please prefer the JavaBean accessor and mutator methods instead using of the data members directly. The implementation is subject to change.

Author:

Michael Nash

See Also:

EventHandler

Field Summary

ByteArrayDataSource[]	attachments The array collection of virtual byte array data source (attachments)
String	dataContext dbName to use for locating the user to notify
boolean	isNotice Is this entry a "notice" or an "event" entry?
String	subject Subject is only used for notice entries
boolean	success Success status of the event
String	theEvent Event is only used for Event entries
String	theMessage Event text body message used for sending electronic mail
int	uid User id to send notice to - only for notices again

Constructor Summary

EventQueueEntry(String newEvent, String newMessage, boolean newSuccess)
A class that represents a queue entry for the Event handler thread

Method Summary

ByteArrayDataSource[]	getAttachments() Gets the Attachments
String	getDataContext() Gets the DataContext
String	getSubject() Gets the Subject
String	getTheEvent() Gets the TheEvent
String	getTheMessage() Gets the TheMessage
int	getUid() Gets the Uid
boolean	isNotice() Gets the Notice
boolean	isSuccess() Gets the Success
void	setAttachments(ByteArrayDataSource[] attachments) Sets the Attachments
void	setDataContext(String dataContext) Sets the DataContext
void	setNotice(boolean notice) Sets the Notice
void	setSubject(String subject) Sets the Subject
void	setSuccess(boolean success) Sets the Success
void	setTheEvent(String theEvent) Sets the TheEvent
void	setTheMessage(String theMessage) Sets the TheMessage
void	setUid(int uid) Sets the Uid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isNotice

public boolean isNotice

Is this entry a "notice" or an "event" entry?

dataContext

public String dataContext

dbName to use for locating the user to notify

subject

public String subject

Subject is only used for notice entries

theEvent

public String theEvent

Event is only used for Event entries

theMessage

public String theMessage

Event text body message used for sending electronic mail

success

public boolean success

Success status of the event

uid

public int uid

User id to send notice to - only for notices again

attachments

public ByteArrayDataSource[] attachments

The array collection of virtual byte array data source (attachments)

Constructor Detail

EventQueueEntry

public EventQueueEntry(String newEvent,
                       String newMessage,
                       boolean newSuccess)

A class that represents a queue entry for the Event handler thread

Parameters:

newEvent - the event name

newMessage - the message

newSuccess - the success flag

Method Detail

isNotice

public boolean isNotice()

Gets the Notice

Returns:

boolean the current value for Notice

See Also:

setNotice(boolean)

setNotice

public void setNotice(boolean notice)

Sets the Notice

Parameters:

notice - the new value for Notice

See Also:

isNotice()

getDataContext

public String getDataContext()

Gets the DataContext

Returns:

String the current value for DataContext

See Also:

setDataContext(String)

setDataContext

public void setDataContext(String dataContext)

Sets the DataContext

Parameters:

dataContext - the new value for DataContext

See Also:

getDataContext()

getSubject

public String getSubject()

Gets the Subject

Returns:

String the current value for Subject

See Also:

setSubject(String)

setSubject

public void setSubject(String subject)

Sets the Subject

Parameters:

subject - the new value for Subject

See Also:

getSubject()

getTheEvent

public String getTheEvent()

Gets the TheEvent

Returns:

String the current value for TheEvent

See Also:

setTheEvent(String)

setTheEvent

public void setTheEvent(String theEvent)

Sets the TheEvent

Parameters:

theEvent - the new value for TheEvent

See Also:

getTheEvent()

getTheMessage

public String getTheMessage()

Gets the TheMessage

Returns:

String the current value for TheMessage

See Also:

setTheMessage(String)

setTheMessage

public void setTheMessage(String theMessage)

Sets the TheMessage

Parameters:

theMessage - the new value for TheMessage

See Also:

getTheMessage()

isSuccess

public boolean isSuccess()

Gets the Success

Returns:

boolean the current value for Success

See Also:

setSuccess(boolean)

setSuccess

public void setSuccess(boolean success)

Sets the Success

Parameters:

success - the new value for Success

See Also:

isSuccess()

getUid

public int getUid()

Gets the Uid

Returns:

int the current value for Uid

See Also:

setUid(int)

setUid

public void setUid(int uid)

Sets the Uid

Parameters:

uid - the new value for Uid

See Also:

getUid()

getAttachments

public ByteArrayDataSource[] getAttachments()

Gets the Attachments

Returns:

ByteArrayDataSource[] the current value for Attachments

See Also:

setAttachments(ByteArrayDataSource[])

setAttachments

public void setAttachments(ByteArrayDataSource[] attachments)

Sets the Attachments

Parameters:

attachments - the new value for Attachments

See Also:

getAttachments()