Package org.kuali.rice.ken.bo

Class NotificationChannelBo

java.lang.Object
org.kuali.rice.krad.bo.BusinessObjectBase
org.kuali.rice.krad.bo.PersistableBusinessObjectBase
org.kuali.rice.ken.bo.NotificationChannelBo
All Implemented Interfaces:
Serializable, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.ken.api.common.KenIdentifiable, org.kuali.rice.ken.api.notification.NotificationChannelContract, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject
@Entity public class NotificationChannelBo extends org.kuali.rice.krad.bo.PersistableBusinessObjectBase implements org.kuali.rice.ken.api.notification.NotificationChannelContract
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:

  • Field Summary

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

    extension, newCollectionRecord, objectId, versionNumber

    Fields inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

    _persistence_cacheKey, _persistence_fetchGroup, _persistence_href, _persistence_links, _persistence_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup

  • Constructor Summary

    Constructors
    Constructor
    Description
    NotificationChannelBo()
    Constructs a NotificationChannel instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRecipientList(NotificationRecipientListBo 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.
    static NotificationChannelBo
    from(org.kuali.rice.ken.api.notification.NotificationChannel im)
    Converts a immutable object to its mutable counterpart
    String
    getDescription()
    Gets the description attribute.
    Long
    getId()
    Gets the id attribute.
    String
    getName()
    Gets the name attribute.
    List<NotificationProducerBo>
    getProducers()
    Gets the producers attribute.
    List<NotificationRecipientListBo>
    getRecipientLists()
    Gets the recipientLists attribute.
    List<NotificationChannelReviewerBo>
    getReviewers()
    Gets the list of reviewers for notification publications to this channel
    List<UserChannelSubscriptionBo>
    getSubscriptions()
    Gets the list of subscriptions to this channel
    int
    hashCode()
     
    boolean
    isSubscribable()
    Gets the subscribable attribute.
    void
    removeRecipientList(NotificationRecipientListBo 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<NotificationProducerBo> producers)
    Sets the producers attribute value.
    void
    setRecipientLists(List<NotificationRecipientListBo> recipientLists)
    Sets the recipientLists attribute value.
    void
    setReviewers(List<NotificationChannelReviewerBo> reviewers)
    Sets the list of reviewers for notification publications to this channel
    void
    setSubscribable(boolean subscribable)
    Sets the subscribable attribute value.
    void
    setSubscriptions(List<UserChannelSubscriptionBo> subscriptions)
    Sets the list of subscriptions to this channel
    static org.kuali.rice.ken.api.notification.NotificationChannel
    to(NotificationChannelBo bo)
    Converts a mutable bo to its immutable counterpart

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

    _persistence_get, _persistence_get_objectId, _persistence_get_versionNumber, _persistence_new, _persistence_post_clone, _persistence_set, _persistence_set_objectId, _persistence_set_versionNumber, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, getObjectId, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

    _persistence_checkFetched, _persistence_checkFetchedForSet, _persistence_getCacheKey, _persistence_getFetchGroup, _persistence_getHref, _persistence_getId, _persistence_getLinks, _persistence_getPropertyChangeListener, _persistence_getRelationships, _persistence_getSession, _persistence_isAttributeFetched, _persistence_propertyChange, _persistence_resetFetchGroup, _persistence_setCacheKey, _persistence_setFetchGroup, _persistence_setHref, _persistence_setId, _persistence_setLinks, _persistence_setPropertyChangeListener, _persistence_setRelationships, _persistence_setSession, _persistence_setShouldRefreshFetchGroup, _persistence_shallow_clone, _persistence_shouldRefreshFetchGroup, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

    getObjectId

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

    toString

    Methods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject

    _persistence_shallow_clone

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Constructor Details

    • NotificationChannelBo

      public NotificationChannelBo()
      Constructs a NotificationChannel instance.

  • Method Details

    • getRecipientLists

      public List<NotificationRecipientListBo> getRecipientLists()
      Gets the recipientLists attribute.
      Specified by:
      getRecipientLists in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      Returns:
      Returns the recipientLists.

    • setRecipientLists

      public void setRecipientLists(List<NotificationRecipientListBo> recipientLists)
      Sets the recipientLists attribute value.
      Parameters:
      recipientLists - The recipientLists to set.

    • addRecipientList

      public void addRecipientList(NotificationRecipientListBo 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(NotificationRecipientListBo recipientList)
      This method removes a recipient list object from the overall list.
      Parameters:
      recipientList -

    • getDescription

      public String getDescription()
      Gets the description attribute.
      Specified by:
      getDescription in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      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.
      Specified by:
      getId in interface org.kuali.rice.ken.api.common.KenIdentifiable
      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.
      Specified by:
      getName in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      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.
      Specified by:
      isSubscribable in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      Returns:
      Returns the subscribable.

    • setSubscribable

      public void setSubscribable(boolean subscribable)
      Sets the subscribable attribute value.
      Parameters:
      subscribable - The subscribable to set.

    • getProducers

      public List<NotificationProducerBo> getProducers()
      Gets the producers attribute.
      Specified by:
      getProducers in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      Returns:
      Returns the producers.

    • setProducers

      public void setProducers(List<NotificationProducerBo> producers)
      Sets the producers attribute value.
      Parameters:
      producers - The producers to set.

    • getReviewers

      public List<NotificationChannelReviewerBo> getReviewers()
      Gets the list of reviewers for notification publications to this channel
      Specified by:
      getReviewers in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      Returns:
      the list of reviewers for notification publications to this channel

    • setReviewers

      public void setReviewers(List<NotificationChannelReviewerBo> 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<UserChannelSubscriptionBo> getSubscriptions()
      Gets the list of subscriptions to this channel
      Specified by:
      getSubscriptions in interface org.kuali.rice.ken.api.notification.NotificationChannelContract
      Returns:
      the list of subscriptions to this channel

    • setSubscriptions

      public void setSubscriptions(List<UserChannelSubscriptionBo> 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:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • to

      public static org.kuali.rice.ken.api.notification.NotificationChannel to(NotificationChannelBo bo)
      Converts a mutable bo to its immutable counterpart
      Parameters:
      bo - the mutable business object
      Returns:
      the immutable object

    • from

      public static NotificationChannelBo from(org.kuali.rice.ken.api.notification.NotificationChannel im)
      Converts a immutable object to its mutable counterpart
      Parameters:
      im - immutable object
      Returns:
      the mutable bo