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

java.lang.Object
  extended by org.kuali.rice.ken.api.notification.Notification.Builder
All Implemented Interfaces:
Serializable, GloballyUnique, Versioned, ModelBuilder, KenIdentifiable, NotificationContract
Enclosing class:
Notification

public static final class Notification.Builder
extends Object
implements Serializable, ModelBuilder, NotificationContract

A builder which can be used to construct Notification instances. Enforces the constraints of the NotificationContract.

See Also:
Serialized Form

Method Summary
 Notification build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static Notification.Builder create()
           
static Notification.Builder create(NotificationContract contract)
           
 org.joda.time.DateTime getAutoRemoveDateTime()
           
 NotificationChannel.Builder getChannel()
           
 String getContent()
           
 String getContentMessage()
           
 NotificationContentType.Builder getContentType()
           
 org.joda.time.DateTime getCreationDateTime()
          This is the namespace code for the Group.
 String getDeliveryType()
           
 Long getId()
           
 org.joda.time.DateTime getLockedDate()
           
 String getObjectId()
          Return the globally unique object id of this object.
 NotificationPriority.Builder getPriority()
           
 String getProcessingFlag()
           
 NotificationProducer.Builder getProducer()
           
 List<NotificationRecipient.Builder> getRecipients()
           
 org.joda.time.DateTime getSendDateTime()
           
 List<NotificationSender.Builder> getSenders()
           
 String getTitle()
           
 Long getVersionNumber()
          Returns the version number for this object.
 void setAutoRemoveDateTime(org.joda.time.DateTime autoRemoveDateTime)
           
 void setChannel(NotificationChannel.Builder channel)
           
 void setContent(String content)
           
 void setContentMessage(String contentMessage)
           
 void setContentType(NotificationContentType.Builder contentType)
           
 void setCreationDateTime(org.joda.time.DateTime creationDateTime)
           
 void setDeliveryType(String deliveryType)
           
 void setId(Long id)
           
 void setLockedDate(org.joda.time.DateTime lockedDate)
           
 void setObjectId(String objectId)
           
 void setPriority(NotificationPriority.Builder priority)
           
 void setProcessingFlag(String processingFlag)
           
 void setProducer(NotificationProducer.Builder producer)
           
 void setRecipients(List<NotificationRecipient.Builder> recipients)
           
 void setSendDateTime(org.joda.time.DateTime sendDateTime)
           
 void setSenders(List<NotificationSender.Builder> senders)
           
 void setTitle(String title)
           
 void setVersionNumber(Long versionNumber)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static Notification.Builder create()

create

public static Notification.Builder create(NotificationContract contract)

build

public Notification build()
Description copied from interface: ModelBuilder
Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:
build in interface ModelBuilder
Returns:
an instance of the object being built by this builder, should never return null

getPriority

public NotificationPriority.Builder getPriority()
Specified by:
getPriority in interface NotificationContract

getContent

public String getContent()
Specified by:
getContent in interface NotificationContract

getChannel

public NotificationChannel.Builder getChannel()
Specified by:
getChannel in interface NotificationContract

getContentType

public NotificationContentType.Builder 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.Builder> getRecipients()
Specified by:
getRecipients in interface NotificationContract

getSenders

public List<NotificationSender.Builder> 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.Builder 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

setPriority

public void setPriority(NotificationPriority.Builder priority)

setContent

public void setContent(String content)

setChannel

public void setChannel(NotificationChannel.Builder channel)

setContentType

public void setContentType(NotificationContentType.Builder contentType)

setCreationDateTime

public void setCreationDateTime(org.joda.time.DateTime creationDateTime)

setRecipients

public void setRecipients(List<NotificationRecipient.Builder> recipients)

setSenders

public void setSenders(List<NotificationSender.Builder> senders)

setAutoRemoveDateTime

public void setAutoRemoveDateTime(org.joda.time.DateTime autoRemoveDateTime)

setDeliveryType

public void setDeliveryType(String deliveryType)

setProducer

public void setProducer(NotificationProducer.Builder producer)

setSendDateTime

public void setSendDateTime(org.joda.time.DateTime sendDateTime)

setProcessingFlag

public void setProcessingFlag(String processingFlag)

setLockedDate

public void setLockedDate(org.joda.time.DateTime lockedDate)

setTitle

public void setTitle(String title)

setContentMessage

public void setContentMessage(String contentMessage)

setId

public void setId(Long id)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.