org.kuali.rice.ken.bo
Class NotificationBo

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.rice.ken.bo.NotificationBo

All Implemented Interfaces:

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

@Entity
public class NotificationBo
extends PersistableBusinessObjectBase
implements NotificationContract, 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

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

extension, versionNumber

Constructor Summary

NotificationBo()
Constructs a Notification instance.

Method Summary

void	addRecipient(NotificationRecipientBo recipient) Adds a recipient
void	addSender(NotificationSenderBo sender) Adds a sender
static NotificationBo	from(Notification im) Converts a immutable object to its mutable counterpart
org.joda.time.DateTime	getAutoRemoveDateTime()
Timestamp	getAutoRemoveDateTimeValue() Gets the autoRemoveDateTime attribute.
NotificationChannelBo	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.
NotificationContentTypeBo	getContentType() Gets the contentType attribute.
org.joda.time.DateTime	getCreationDateTime() This is the namespace code for the Group.
Timestamp	getCreationDateTimeValue() Returns when this Notification entry was created
String	getDeliveryType() Gets the deliveryType attribute.
String	getDocTypeName() Gets the custom document type name
Long	getId() Gets the id attribute.
org.joda.time.DateTime	getLockedDate()
Timestamp	getLockedDateValue() Gets the lockedDate attribute.
Integer	getLockVerNbr() Return value of lock column for OJB optimistic locking
NotificationPriorityBo	getPriority() Gets the priority attribute.
String	getProcessingFlag() Gets the processingFlag attribute.
NotificationProducerBo	getProducer() Gets the producer attribute.
NotificationRecipientBo	getRecipient(int index) Retrieves a recipient at the specified index
List<NotificationRecipientBo>	getRecipients() Gets the recipients attribute.
org.joda.time.DateTime	getSendDateTime()
Timestamp	getSendDateTimeValue() Gets the sendDateTime attribute.
NotificationSenderBo	getSender(int index) Retrieves a sender at the specified index
List<NotificationSenderBo>	getSenders() Gets the senders attribute.
String	getTitle() Gets the title
void	setAutoRemoveDateTimeValue(Timestamp autoRemoveDateTimeValue) Sets the autoRemoveDateTime attribute value.
void	setChannel(NotificationChannelBo channel) Sets the channel attribute value.
void	setContent(String content) Sets the content attribute value.
void	setContentType(NotificationContentTypeBo contentType) Sets the contentType attribute value.
void	setCreationDateTimeValue(Timestamp created) Sets the creation date of this Notification entry
void	setDeliveryType(String deliveryType) Sets the deliveryType attribute value.
void	setDocTypeName(String docTypeName) Sets the custom document type name.
void	setId(Long id) Sets the id attribute value.
void	setLockedDateValue(Timestamp lockedDateValue) Sets the lockedDate attribute value.
void	setLockVerNbr(Integer lockVerNbr) Set value of lock column for OJB optimistic locking
void	setPriority(NotificationPriorityBo priority) Sets the priority attribute value.
void	setProcessingFlag(String processingFlag) Sets the processingFlag attribute value.
void	setProducer(NotificationProducerBo producer) Sets the producer attribute value.
void	setRecipients(List<NotificationRecipientBo> recipients) Sets the recipients attribute value.
void	setSendDateTimeValue(Timestamp sendDateTimeValue) Sets the sendDateTime attribute value.
void	setSenders(List<NotificationSenderBo> senders) Sets the senders attribute value.
void	setTitle(String title) Sets the title
static Notification	to(NotificationBo bo) Converts a mutable bo to its immutable counterpart

Methods inherited from class org.kuali.rice.krad.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.krad.bo.BusinessObjectBase

toString

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.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

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

toString

Constructor Detail

NotificationBo

public NotificationBo()

Constructs a Notification instance.

Method Detail

getCreationDateTimeValue

public Timestamp getCreationDateTimeValue()

Returns when this Notification entry was created

Returns:

when this Notification entry was created

getCreationDateTime

public org.joda.time.DateTime getCreationDateTime()

Description copied from interface: NotificationContract

This is the namespace code for the Group.

This is a namespace code assigned to a Group. Together with name, it makes up another unique identifier for Group

Specified by:

getCreationDateTime in interface NotificationContract

Returns:

namespaceCode

setCreationDateTimeValue

public void setCreationDateTimeValue(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<NotificationRecipientBo> getRecipients()

Gets the recipients attribute.

Specified by:

getRecipients in interface NotificationContract

Returns:

Returns the recipients.

setRecipients

public void setRecipients(List<NotificationRecipientBo> recipients)

Sets the recipients attribute value.

Parameters:

recipients - The recipients to set.

getRecipient

public NotificationRecipientBo 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(NotificationRecipientBo recipient)

Adds a recipient

Parameters:

recipient - The recipient to add

getSenders

public List<NotificationSenderBo> getSenders()

Gets the senders attribute.

Specified by:

getSenders in interface NotificationContract

Returns:

Returns the senders.

setSenders

public void setSenders(List<NotificationSenderBo> senders)

Sets the senders attribute value.

Parameters:

senders - The senders to set.

getSender

public NotificationSenderBo 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(NotificationSenderBo sender)

Adds a sender

Parameters:

sender - The sender to add

getAutoRemoveDateTimeValue

public Timestamp getAutoRemoveDateTimeValue()

Gets the autoRemoveDateTime attribute.

Returns:

Returns the autoRemoveDateTime.

getAutoRemoveDateTime

public org.joda.time.DateTime getAutoRemoveDateTime()

Specified by:

getAutoRemoveDateTime in interface NotificationContract

setAutoRemoveDateTimeValue

public void setAutoRemoveDateTimeValue(Timestamp autoRemoveDateTimeValue)

Sets the autoRemoveDateTime attribute value.

Parameters:

autoRemoveDateTimeValue - The autoRemoveDateTime to set.

getChannel

public NotificationChannelBo getChannel()

Gets the channel attribute.

Specified by:

getChannel in interface NotificationContract

Returns:

Returns the channel.

setChannel

public void setChannel(NotificationChannelBo channel)

Sets the channel attribute value.

Parameters:

channel - The channel to set.

getContent

public String getContent()

Gets the content attribute.

Specified by:

getContent in interface NotificationContract

Returns:

Returns the content.

setContent

public void setContent(String content)

Sets the content attribute value.

Parameters:

content - The content to set.

getContentType

public NotificationContentTypeBo getContentType()

Gets the contentType attribute.

Specified by:

getContentType in interface NotificationContract

Returns:

Returns the contentType.

setContentType

public void setContentType(NotificationContentTypeBo contentType)

Sets the contentType attribute value.

Parameters:

contentType - The contentType to set.

getDeliveryType

public String getDeliveryType()

Gets the deliveryType attribute.

Specified by:

getDeliveryType in interface NotificationContract

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.

Specified by:

getId in interface KenIdentifiable

Returns:

Returns the id.

setId

public void setId(Long id)

Sets the id attribute value.

Parameters:

id - The id to set.

getPriority

public NotificationPriorityBo getPriority()

Gets the priority attribute.

Specified by:

getPriority in interface NotificationContract

Returns:

Returns the priority.

setPriority

public void setPriority(NotificationPriorityBo priority)

Sets the priority attribute value.

Parameters:

priority - The priority to set.

getProducer

public NotificationProducerBo getProducer()

Gets the producer attribute.

Specified by:

getProducer in interface NotificationContract

Returns:

Returns the producer.

setProducer

public void setProducer(NotificationProducerBo producer)

Sets the producer attribute value.

Parameters:

producer - The producer to set.

getSendDateTimeValue

public Timestamp getSendDateTimeValue()

Gets the sendDateTime attribute.

Returns:

Returns the sendDateTime.

getSendDateTime

public org.joda.time.DateTime getSendDateTime()

Specified by:

getSendDateTime in interface NotificationContract

setSendDateTimeValue

public void setSendDateTimeValue(Timestamp sendDateTimeValue)

Sets the sendDateTime attribute value.

Parameters:

sendDateTimeValue - The sendDateTime to set.

getProcessingFlag

public String getProcessingFlag()

Gets the processingFlag attribute.

Specified by:

getProcessingFlag in interface NotificationContract

Returns:

Returns the processingFlag.

setProcessingFlag

public void setProcessingFlag(String processingFlag)

Sets the processingFlag attribute value.

Parameters:

processingFlag - The processingFlag to set.

getLockedDateValue

public Timestamp getLockedDateValue()

Gets the lockedDate attribute.

Specified by:

getLockedDateValue in interface Lockable

Returns:

Returns the lockedDate.

getLockedDate

public org.joda.time.DateTime getLockedDate()

Specified by:

getLockedDate in interface NotificationContract

setLockedDateValue

public void setLockedDateValue(Timestamp lockedDateValue)

Sets the lockedDate attribute value.

Specified by:

setLockedDateValue in interface Lockable

Parameters:

lockedDateValue - The lockedDate to set.

getTitle

public String getTitle()

Gets the title

Specified by:

getTitle in interface NotificationContract

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.

Specified by:

getContentMessage in interface NotificationContract

Returns:

String

getDocTypeName

public String getDocTypeName()

Gets the custom document type name

If null, the system will use the default KualiNotification document type when routing the notification

Specified by:

getDocTypeName in interface NotificationContract

Returns:

the custom document type name for this Notification, or null if undefined

setDocTypeName

public void setDocTypeName(String docTypeName)

Sets the custom document type name.

If null, the system will use the default KualiNotification document type when routing the notification. If the document type does not match any document type name in the system, the system behavior is undefined.

Parameters:

docTypeName - document type name of this notification

to

public static Notification to(NotificationBo bo)

Converts a mutable bo to its immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

from

public static NotificationBo from(Notification im)

Converts a immutable object to its mutable counterpart

Parameters:

im - immutable object

Returns:

the mutable bo