org.kuali.rice.ken.api.notification

Class NotificationProducer.Builder

java.lang.Object

org.kuali.rice.ken.api.notification.NotificationProducer.Builder

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelBuilder, KenIdentifiable, NotificationProducerContract

Enclosing class:

NotificationProducer

public static final class NotificationProducer.Builder
extends Object
implements Serializable, ModelBuilder, NotificationProducerContract

A builder which can be used to construct NotificationProducer instances. Enforces the constraints of the NotificationProducerContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
NotificationProducer	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static NotificationProducer.Builder	create()
static NotificationProducer.Builder	create(NotificationProducerContract contract)
List<Long>	getChannelIds()
String	getContactInfo()
String	getDescription()
Long	getId()
String	getName()
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this object.
void	setChannelIds(List<Long> channelIds)
void	setContactInfo(String contactInfo)
void	setDescription(String description)
void	setId(Long id)
void	setName(String name)
void	setObjectId(String objectId)
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 NotificationProducer.Builder create()

create

public static NotificationProducer.Builder create(NotificationProducerContract contract)

build

public NotificationProducer 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

getName

public String getName()

Specified by:

getName in interface NotificationProducerContract

getDescription

public String getDescription()

Specified by:

getDescription in interface NotificationProducerContract

getContactInfo

public String getContactInfo()

Specified by:

getContactInfo in interface NotificationProducerContract

getId

public Long getId()

Specified by:

getId in interface KenIdentifiable

getChannelIds

public List<Long> getChannelIds()

Specified by:

getChannelIds in interface NotificationProducerContract

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

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setContactInfo

public void setContactInfo(String contactInfo)

setId

public void setId(Long id)

setChannelIds

public void setChannelIds(List<Long> channelIds)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)