org.kuali.rice.ken.api.notification
Class Notification

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.ken.api.notification.Notification

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, KenIdentifiable, NotificationContract

public final class Notification
extends AbstractDataTransferObject
implements NotificationContract

See Also:

Serialized Form

Nested Class Summary

static class

Notification.Builder A builder which can be used to construct Notification instances.

Method Summary

org.joda.time.DateTime	getAutoRemoveDateTime()
NotificationChannel	getChannel()
String	getContent()
String	getContentMessage()
NotificationContentType	getContentType()
org.joda.time.DateTime	getCreationDateTime() This is the namespace code for the Group.
String	getDeliveryType()
String	getDocTypeName() Gets the custom document type name
Long	getId()
org.joda.time.DateTime	getLockedDate()
String	getObjectId() Return the globally unique object id of this object.
NotificationPriority	getPriority()
String	getProcessingFlag()
NotificationProducer	getProducer()
List<NotificationRecipient>	getRecipients()
org.joda.time.DateTime	getSendDateTime()
List<NotificationSender>	getSenders()
String	getTitle()
Long	getVersionNumber() Returns the version number for this object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPriority

public NotificationPriority getPriority()

Specified by:

getPriority in interface NotificationContract

getContent

public String getContent()

Specified by:

getContent in interface NotificationContract

getChannel

public NotificationChannel getChannel()

Specified by:

getChannel in interface NotificationContract

getContentType

public NotificationContentType getContentType()

Specified by:

getContentType in interface NotificationContract

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

getRecipients

public List<NotificationRecipient> getRecipients()

Specified by:

getRecipients in interface NotificationContract

getSenders

public List<NotificationSender> getSenders()

Specified by:

getSenders in interface NotificationContract

getAutoRemoveDateTime

public org.joda.time.DateTime getAutoRemoveDateTime()

Specified by:

getAutoRemoveDateTime in interface NotificationContract

getDeliveryType

public String getDeliveryType()

Specified by:

getDeliveryType in interface NotificationContract

getProducer

public NotificationProducer getProducer()

Specified by:

getProducer in interface NotificationContract

getSendDateTime

public org.joda.time.DateTime getSendDateTime()

Specified by:

getSendDateTime in interface NotificationContract

getProcessingFlag

public String getProcessingFlag()

Specified by:

getProcessingFlag in interface NotificationContract

getLockedDate

public org.joda.time.DateTime getLockedDate()

Specified by:

getLockedDate in interface NotificationContract

getTitle

public String getTitle()

Specified by:

getTitle in interface NotificationContract

getContentMessage

public String getContentMessage()

Specified by:

getContentMessage in interface NotificationContract

getId

public Long getId()

Specified by:

getId in interface KenIdentifiable

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet

getDocTypeName

public String getDocTypeName()

Description copied from interface: NotificationContract

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