NotificationChannel.Builder (Rice 2.4.2 API)

java.lang.Object
- org.kuali.rice.ken.api.notification.NotificationChannel.Builder

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelBuilder, KenIdentifiable, NotificationChannelContract

Enclosing class:

NotificationChannel
```
public static final class NotificationChannel.Builder
extends Object
implements Serializable, ModelBuilder, NotificationChannelContract
```
A builder which can be used to construct NotificationChannel instances. Enforces the constraints of the NotificationChannelContract.

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`NotificationChannel`	`build()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static NotificationChannel.Builder`	`create()`
`static NotificationChannel.Builder`	`create(NotificationChannelContract contract)`
`String`	`getDescription()`
`Long`	`getId()`
`String`	`getName()`
`String`	`getObjectId()` Return the globally unique object id of this object.
`List<NotificationProducer.Builder>`	`getProducers()`
`List<NotificationListRecipient.Builder>`	`getRecipientLists()`
`List<NotificationChannelReviewer.Builder>`	`getReviewers()`
`List<UserChannelSubscription.Builder>`	`getSubscriptions()`
`Long`	`getVersionNumber()` Returns the version number for this object.
`boolean`	`isSubscribable()`
`void`	`setDescription(String description)`
`void`	`setId(Long id)`
`void`	`setName(String name)`
`void`	`setObjectId(String objectId)`
`void`	`setProducers(List<NotificationProducer.Builder> producers)`
`void`	`setRecipientLists(List<NotificationListRecipient.Builder> recipientLists)`
`void`	`setReviewers(List<NotificationChannelReviewer.Builder> reviewers)`
`void`	`setSubscribable(boolean subscribable)`
`void`	`setSubscriptions(List<UserChannelSubscription.Builder> subscriptions)`
`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 NotificationChannel.Builder create()
```
  - create
```
public static NotificationChannel.Builder create(NotificationChannelContract contract)
```
  - build
```
public NotificationChannel 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 NotificationChannelContract
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface NotificationChannelContract
  - isSubscribable
```
public boolean isSubscribable()
```
    Specified by:
    
    isSubscribable in interface NotificationChannelContract
  - getRecipientLists
```
public List<NotificationListRecipient.Builder> getRecipientLists()
```
    Specified by:
    
    getRecipientLists in interface NotificationChannelContract
  - getProducers
```
public List<NotificationProducer.Builder> getProducers()
```
    Specified by:
    
    getProducers in interface NotificationChannelContract
  - getReviewers
```
public List<NotificationChannelReviewer.Builder> getReviewers()
```
    Specified by:
    
    getReviewers in interface NotificationChannelContract
  - getSubscriptions
```
public List<UserChannelSubscription.Builder> getSubscriptions()
```
    Specified by:
    
    getSubscriptions in interface NotificationChannelContract
  - 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
  - setName
```
public void setName(String name)
```
  - setDescription
```
public void setDescription(String description)
```
  - setSubscribable
```
public void setSubscribable(boolean subscribable)
```
  - setRecipientLists
```
public void setRecipientLists(List<NotificationListRecipient.Builder> recipientLists)
```
  - setProducers
```
public void setProducers(List<NotificationProducer.Builder> producers)
```
  - setReviewers
```
public void setReviewers(List<NotificationChannelReviewer.Builder> reviewers)
```
  - setSubscriptions
```
public void setSubscriptions(List<UserChannelSubscription.Builder> subscriptions)
```
  - setId
```
public void setId(Long id)
```
  - setVersionNumber
```
public void setVersionNumber(Long versionNumber)
```
  - setObjectId
```
public void setObjectId(String objectId)
```

Class NotificationChannel.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

build

getName

getDescription

isSubscribable

getRecipientLists

getProducers

getReviewers

getSubscriptions

getId

getVersionNumber

getObjectId

setName

setDescription

setSubscribable

setRecipientLists

setProducers

setReviewers

setSubscriptions

setId

setVersionNumber

setObjectId