org.kuali.rice.ken.api.notification

Class UserChannelSubscription.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelBuilder, KenIdentifiable, UserChannelSubscriptionContract

Enclosing class:

UserChannelSubscription

public static final class UserChannelSubscription.Builder
extends Object
implements Serializable, ModelBuilder, UserChannelSubscriptionContract

A builder which can be used to construct UserChannelSubscription instances. Enforces the constraints of the UserChannelSubscriptionContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
UserChannelSubscription	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static UserChannelSubscription.Builder	create()
static UserChannelSubscription.Builder	create(UserChannelSubscriptionContract contract)
NotificationChannel.Builder	getChannel()
Long	getId()
String	getObjectId() Return the globally unique object id of this object.
String	getUserId()
Long	getVersionNumber() Returns the version number for this object.
void	setChannel(NotificationChannel.Builder channel)
void	setId(Long id)
void	setObjectId(String objectId)
void	setUserId(String userId)
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 UserChannelSubscription.Builder create()

create

public static UserChannelSubscription.Builder create(UserChannelSubscriptionContract contract)

build

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

getChannel

public NotificationChannel.Builder getChannel()

Specified by:

getChannel in interface UserChannelSubscriptionContract

getUserId

public String getUserId()

Specified by:

getUserId in interface UserChannelSubscriptionContract

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

setChannel

public void setChannel(NotificationChannel.Builder channel)

setUserId

public void setUserId(String userId)

setId

public void setId(Long id)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)