Package 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, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.ken.api.common.KenIdentifiable, org.kuali.rice.ken.api.notification.NotificationContract, Lockable, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject
@Entity public class NotificationBo extends org.kuali.rice.krad.bo.PersistableBusinessObjectBase implements org.kuali.rice.ken.api.notification.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:

  • Constructor Details

    • NotificationBo

      public NotificationBo()
      Constructs a Notification instance.

  • Method Details

    • 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()
      Specified by:
      getCreationDateTime in interface org.kuali.rice.ken.api.notification.NotificationContract

    • 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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.common.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.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 org.kuali.rice.ken.api.notification.NotificationContract
      Returns:
      String

    • getDocTypeName

      public String getDocTypeName()
      Specified by:
      getDocTypeName in interface org.kuali.rice.ken.api.notification.NotificationContract

    • 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 org.kuali.rice.ken.api.notification.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(org.kuali.rice.ken.api.notification.Notification im)
      Converts a immutable object to its mutable counterpart
      Parameters:
      im - immutable object
      Returns:
      the mutable bo