org.kuali.rice.ken.bo
Class NotificationChannel

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.ken.bo.NotificationChannel

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, BusinessObject, PersistableBusinessObject

@Entity
public class NotificationChannel
extends PersistableBusinessObjectBase

This class represents and instance of a Notification Channel. A Notification Channel is correlated to a specific class of notification, or in other words a specific business purpose. For instance, all overdue books from a specific library could be a channel or a channel for concerts coming to campus could be another channel.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

private String	description
private Long	id
private String	name
private List<NotificationProducer>	producers
private List<NotificationRecipientList>	recipientLists
private List<NotificationChannelReviewer>	reviewers
private boolean	subscribable
private List<UserChannelSubscription>	subscriptions

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

NotificationChannel()
Constructs a NotificationChannel instance.

Method Summary

void	addRecipientList(NotificationRecipientList recipientList) This method adds a recipient list to the overall set of recipient lists that are associated with this channnel.
boolean	equals(Object obj) Compares the id values of each NotificationChannel object.
String	getDescription() Gets the description attribute.
Long	getId() Gets the id attribute.
String	getName() Gets the name attribute.
List<NotificationProducer>	getProducers() Gets the producers attribute.
List<NotificationRecipientList>	getRecipientLists() Gets the recipientLists attribute.
List<NotificationChannelReviewer>	getReviewers() Gets the list of reviewers for notification publications to this channel
List<UserChannelSubscription>	getSubscriptions() Gets the list of subscriptions to this channel
boolean	isSubscribable() Gets the subscribable attribute.
void	removeRecipientList(NotificationRecipientList recipientList) This method removes a recipient list object from the overall list.
void	setDescription(String description) Sets the description attribute value.
void	setId(Long id) Sets the id attribute value.
void	setName(String name) Sets the name attribute value.
void	setProducers(List<NotificationProducer> producers) Sets the producers attribute value.
void	setRecipientLists(List<NotificationRecipientList> recipientLists) Sets the recipientLists attribute value.
void	setReviewers(List<NotificationChannelReviewer> reviewers) Sets the list of reviewers for notification publications to this channel
void	setSubscribable(boolean subscribable) Sets the subscribable attribute value.
void	setSubscriptions(List<UserChannelSubscription> subscriptions) Sets the list of subscriptions to this channel

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder, toStringMapper

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

id

private Long id

name

private String name

description

private String description

subscribable

private boolean subscribable

recipientLists

private List<NotificationRecipientList> recipientLists

producers

private List<NotificationProducer> producers

reviewers

private List<NotificationChannelReviewer> reviewers

subscriptions

private List<UserChannelSubscription> subscriptions

Constructor Detail

NotificationChannel

public NotificationChannel()

Constructs a NotificationChannel instance.

Method Detail

getRecipientLists

public List<NotificationRecipientList> getRecipientLists()

Gets the recipientLists attribute.

Returns:

Returns the recipientLists.

setRecipientLists

public void setRecipientLists(List<NotificationRecipientList> recipientLists)

Sets the recipientLists attribute value.

Parameters:

recipientLists - The recipientLists to set.

addRecipientList

public void addRecipientList(NotificationRecipientList recipientList)

This method adds a recipient list to the overall set of recipient lists that are associated with this channnel.

Parameters:

recipientList -

removeRecipientList

public void removeRecipientList(NotificationRecipientList recipientList)

This method removes a recipient list object from the overall list.

Parameters:

recipientList -

getDescription

public String getDescription()

Gets the description attribute.

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Sets the description attribute value.

Parameters:

description - The description to set.

getId

public Long getId()

Gets the id attribute.

Returns:

Returns the id.

setId

public void setId(Long id)

Sets the id attribute value.

Parameters:

id - The id to set.

getName

public String getName()

Gets the name attribute.

Returns:

Returns the name.

setName

public void setName(String name)

Sets the name attribute value.

Parameters:

name - The name to set.

isSubscribable

public boolean isSubscribable()

Gets the subscribable attribute.

Returns:

Returns the subscribable.

setSubscribable

public void setSubscribable(boolean subscribable)

Sets the subscribable attribute value.

Parameters:

subscribable - The subscribable to set.

getProducers

public List<NotificationProducer> getProducers()

Gets the producers attribute.

Returns:

Returns the producers.

setProducers

public void setProducers(List<NotificationProducer> producers)

Sets the producers attribute value.

Parameters:

producers - The producers to set.

getReviewers

public List<NotificationChannelReviewer> getReviewers()

Gets the list of reviewers for notification publications to this channel

Returns:

the list of reviewers for notification publications to this channel

setReviewers

public void setReviewers(List<NotificationChannelReviewer> reviewers)

Sets the list of reviewers for notification publications to this channel

Parameters:

reviewers - the list of reviewers for notification publications to this channel

getSubscriptions

public List<UserChannelSubscription> getSubscriptions()

Gets the list of subscriptions to this channel

Returns:

the list of subscriptions to this channel

setSubscriptions

public void setSubscriptions(List<UserChannelSubscription> subscriptions)

Sets the list of subscriptions to this channel

Parameters:

subscriptions - the list of subscriptions to this channel

equals

public boolean equals(Object obj)

Compares the id values of each NotificationChannel object.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)