org.kuali.rice.ken.bo
Class Notification

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.ken.bo.Notification

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, Lockable, BusinessObject, PersistableBusinessObject

@Entity
public class Notification
extends PersistableBusinessObjectBase
implements Lockable

This class represents an instace of a notification message that is received by the overall system.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

private Timestamp	autoRemoveDateTime
private NotificationChannel	channel
private String	content
private NotificationContentType	contentType
private Timestamp	creationDateTime
private String	deliveryType
private Long	id
private Timestamp	lockedDate
private NotificationPriority	priority Lock column for OJB optimistic locking
private String	processingFlag
private NotificationProducer	producer
private List<NotificationRecipient>	recipients
private Timestamp	sendDateTime
private List<NotificationSender>	senders
private String	title

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Notification()
Constructs a Notification instance.

Method Summary

void	addRecipient(NotificationRecipient recipient) Adds a recipient
void	addSender(NotificationSender sender) Adds a sender
Timestamp	getAutoRemoveDateTime() Gets the autoRemoveDateTime attribute.
NotificationChannel	getChannel() Gets the channel attribute.
String	getContent() Gets the content attribute.
String	getContentMessage() This method just uses StringUtils to get at the content of the tag that exists in the notification content.
NotificationContentType	getContentType() Gets the contentType attribute.
Timestamp	getCreationDateTime() Returns when this Notification entry was created
String	getDeliveryType() Gets the deliveryType attribute.
Long	getId() Gets the id attribute.
Timestamp	getLockedDate() Gets the lockedDate attribute.
Integer	getLockVerNbr() Return value of lock column for OJB optimistic locking
NotificationPriority	getPriority() Gets the priority attribute.
String	getProcessingFlag() Gets the processingFlag attribute.
NotificationProducer	getProducer() Gets the producer attribute.
NotificationRecipient	getRecipient(int index) Retrieves a recipient at the specified index
List<NotificationRecipient>	getRecipients() Gets the recipients attribute.
Timestamp	getSendDateTime() Gets the sendDateTime attribute.
NotificationSender	getSender(int index) Retrieves a sender at the specified index
List<NotificationSender>	getSenders() Gets the senders attribute.
String	getTitle() Gets the title
void	setAutoRemoveDateTime(Timestamp autoRemoveDateTime) Sets the autoRemoveDateTime attribute value.
void	setChannel(NotificationChannel channel) Sets the channel attribute value.
void	setContent(String content) Sets the content attribute value.
void	setContentType(NotificationContentType contentType) Sets the contentType attribute value.
void	setCreationDateTime(Timestamp created) Sets the creation date of this Notification entry
void	setDeliveryType(String deliveryType) Sets the deliveryType attribute value.
void	setId(Long id) Sets the id attribute value.
void	setLockedDate(Timestamp lockedDate) Sets the lockedDate attribute value.
void	setLockVerNbr(Integer lockVerNbr) Set value of lock column for OJB optimistic locking
void	setPriority(NotificationPriority priority) Sets the priority attribute value.
void	setProcessingFlag(String processingFlag) Sets the processingFlag attribute value.
void	setProducer(NotificationProducer producer) Sets the producer attribute value.
void	setRecipients(List<NotificationRecipient> recipients) Sets the recipients attribute value.
void	setSendDateTime(Timestamp sendDateTime) Sets the sendDateTime attribute value.
void	setSenders(List<NotificationSender> senders) Sets the senders attribute value.
void	setTitle(String title) Sets the title

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder, toStringMapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

id

private Long id

deliveryType

private String deliveryType

creationDateTime

private Timestamp creationDateTime

sendDateTime

private Timestamp sendDateTime

autoRemoveDateTime

private Timestamp autoRemoveDateTime

title

private String title

content

private String content

processingFlag

private String processingFlag

lockedDate

private Timestamp lockedDate

priority

private NotificationPriority priority

Lock column for OJB optimistic locking

contentType

private NotificationContentType contentType

channel

private NotificationChannel channel

producer

private NotificationProducer producer

recipients

private List<NotificationRecipient> recipients

senders

private List<NotificationSender> senders

Constructor Detail

Notification

public Notification()

Constructs a Notification instance.

Method Detail

getCreationDateTime

public Timestamp getCreationDateTime()

Returns when this Notification entry was created

Returns:

when this Notification entry was created

setCreationDateTime

public void setCreationDateTime(Timestamp created)

Sets the creation date of this Notification entry

Parameters:

created - the creation date of this Notification entry

getLockVerNbr

public Integer getLockVerNbr()

Return value of lock column for OJB optimistic locking

Returns:

value of lock column for OJB optimistic locking

setLockVerNbr

public void setLockVerNbr(Integer lockVerNbr)

Set value of lock column for OJB optimistic locking

Parameters:

lockVerNbr - value of lock column for OJB optimistic locking

getRecipients

public List<NotificationRecipient> getRecipients()

Gets the recipients attribute.

Returns:

Returns the recipients.

setRecipients

public void setRecipients(List<NotificationRecipient> recipients)

Sets the recipients attribute value.

Parameters:

recipients - The recipients to set.

getRecipient

public NotificationRecipient getRecipient(int index)

Retrieves a recipient at the specified index

Parameters:

index - the index in the recipients collection

Returns:

the recipient if found or null

addRecipient

public void addRecipient(NotificationRecipient recipient)

Adds a recipient

Parameters:

recipient - The recipient to add

getSenders

public List<NotificationSender> getSenders()

Gets the senders attribute.

Returns:

Returns the senders.

setSenders

public void setSenders(List<NotificationSender> senders)

Sets the senders attribute value.

Parameters:

senders - The senders to set.

getSender

public NotificationSender getSender(int index)

Retrieves a sender at the specified index

Parameters:

index - the index in the senders collection

Returns:

the sender if found or null

addSender

public void addSender(NotificationSender sender)

Adds a sender

Parameters:

sender - The sender to add

getAutoRemoveDateTime

public Timestamp getAutoRemoveDateTime()

Gets the autoRemoveDateTime attribute.

Returns:

Returns the autoRemoveDateTime.

setAutoRemoveDateTime

public void setAutoRemoveDateTime(Timestamp autoRemoveDateTime)

Sets the autoRemoveDateTime attribute value.

Parameters:

autoRemoveDateTime - The autoRemoveDateTime to set.

getChannel

public NotificationChannel getChannel()

Gets the channel attribute.

Returns:

Returns the channel.

setChannel

public void setChannel(NotificationChannel channel)

Sets the channel attribute value.

Parameters:

channel - The channel to set.

getContent

public String getContent()

Gets the content attribute.

Returns:

Returns the content.

setContent

public void setContent(String content)

Sets the content attribute value.

Parameters:

content - The content to set.

getContentType

public NotificationContentType getContentType()

Gets the contentType attribute.

Returns:

Returns the contentType.

setContentType

public void setContentType(NotificationContentType contentType)

Sets the contentType attribute value.

Parameters:

contentType - The contentType to set.

getDeliveryType

public String getDeliveryType()

Gets the deliveryType attribute.

Returns:

Returns the deliveryType.

setDeliveryType

public void setDeliveryType(String deliveryType)

Sets the deliveryType attribute value.

Parameters:

deliveryType - The deliveryType to set.

getId

public Long getId()

Gets the id attribute.

Returns:

Returns the id.

setId

public void setId(Long id)

Sets the id attribute value.

Parameters:

id - The id to set.

getPriority

public NotificationPriority getPriority()

Gets the priority attribute.

Returns:

Returns the priority.

setPriority

public void setPriority(NotificationPriority priority)

Sets the priority attribute value.

Parameters:

priority - The priority to set.

getProducer

public NotificationProducer getProducer()

Gets the producer attribute.

Returns:

Returns the producer.

setProducer

public void setProducer(NotificationProducer producer)

Sets the producer attribute value.

Parameters:

producer - The producer to set.

getSendDateTime

public Timestamp getSendDateTime()

Gets the sendDateTime attribute.

Returns:

Returns the sendDateTime.

setSendDateTime

public void setSendDateTime(Timestamp sendDateTime)

Sets the sendDateTime attribute value.

Parameters:

sendDateTime - The sendDateTime to set.

getProcessingFlag

public String getProcessingFlag()

Gets the processingFlag attribute.

Returns:

Returns the processingFlag.

setProcessingFlag

public void setProcessingFlag(String processingFlag)

Sets the processingFlag attribute value.

Parameters:

processingFlag - The processingFlag to set.

getLockedDate

public Timestamp getLockedDate()

Gets the lockedDate attribute.

Specified by:

getLockedDate in interface Lockable

Returns:

Returns the lockedDate.

setLockedDate

public void setLockedDate(Timestamp lockedDate)

Sets the lockedDate attribute value.

Specified by:

setLockedDate in interface Lockable

Parameters:

lockedDate - The lockedDate to set.

getTitle

public String getTitle()

Gets the title

Returns:

the title of this notification

setTitle

public void setTitle(String title)

Sets the title

Parameters:

title - the title of this notification

getContentMessage

public String getContentMessage()

This method just uses StringUtils to get at the content of the tag that exists in the notification content.

Returns:

String