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,GloballyUnique,Versioned,ModelObjectBasic,KenIdentifiable,NotificationChannelContract,BusinessObject,PersistableBusinessObject
@Entity
public class NotificationChannelBo
extends PersistableBusinessObjectBase
implements 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, versionNumberFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRecipientList(NotificationRecipientListBo recipientList) This method adds a recipient list to the overall set of recipient lists that are associated with this channnel.booleanCompares the id values of each NotificationChannel object.static NotificationChannelBoConverts a immutable object to its mutable counterpartGets the description attribute.getId()Gets the id attribute.getName()Gets the name attribute.Gets the producers attribute.Gets the recipientLists attribute.Gets the list of reviewers for notification publications to this channelGets the list of subscriptions to this channelinthashCode()booleanGets the subscribable attribute.voidremoveRecipientList(NotificationRecipientListBo recipientList) This method removes a recipient list object from the overall list.voidsetDescription(String description) Sets the description attribute value.voidSets the id attribute value.voidSets the name attribute value.voidsetProducers(List<NotificationProducerBo> producers) Sets the producers attribute value.voidsetRecipientLists(List<NotificationRecipientListBo> recipientLists) Sets the recipientLists attribute value.voidsetReviewers(List<NotificationChannelReviewerBo> reviewers) Sets the list of reviewers for notification publications to this channelvoidsetSubscribable(boolean subscribable) Sets the subscribable attribute value.voidsetSubscriptions(List<UserChannelSubscriptionBo> subscriptions) Sets the list of subscriptions to this channelstatic NotificationChannelConverts a mutable bo to its immutable counterpartMethods 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, setVersionNumberMethods 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, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique
getObjectIdMethods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toStringMethods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject
_persistence_shallow_cloneMethods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber
-
Constructor Details
-
NotificationChannelBo
public NotificationChannelBo()Constructs a NotificationChannel instance.
-
-
Method Details
-
getRecipientLists
Gets the recipientLists attribute.- Specified by:
getRecipientListsin interfaceNotificationChannelContract- Returns:
- Returns the recipientLists.
-
setRecipientLists
Sets the recipientLists attribute value.- Parameters:
recipientLists- The recipientLists to set.
-
addRecipientList
This method adds a recipient list to the overall set of recipient lists that are associated with this channnel.- Parameters:
recipientList-
-
removeRecipientList
This method removes a recipient list object from the overall list.- Parameters:
recipientList-
-
getDescription
Gets the description attribute.- Specified by:
getDescriptionin interfaceNotificationChannelContract- Returns:
- Returns the description.
-
setDescription
Sets the description attribute value.- Parameters:
description- The description to set.
-
getId
Gets the id attribute.- Specified by:
getIdin interfaceKenIdentifiable- Returns:
- Returns the id.
-
setId
Sets the id attribute value.- Parameters:
id- The id to set.
-
getName
Gets the name attribute.- Specified by:
getNamein interfaceNotificationChannelContract- Returns:
- Returns the name.
-
setName
Sets the name attribute value.- Parameters:
name- The name to set.
-
isSubscribable
public boolean isSubscribable()Gets the subscribable attribute.- Specified by:
isSubscribablein interfaceNotificationChannelContract- Returns:
- Returns the subscribable.
-
setSubscribable
public void setSubscribable(boolean subscribable) Sets the subscribable attribute value.- Parameters:
subscribable- The subscribable to set.
-
getProducers
Gets the producers attribute.- Specified by:
getProducersin interfaceNotificationChannelContract- Returns:
- Returns the producers.
-
setProducers
Sets the producers attribute value.- Parameters:
producers- The producers to set.
-
getReviewers
Gets the list of reviewers for notification publications to this channel- Specified by:
getReviewersin interfaceNotificationChannelContract- Returns:
- the list of reviewers for notification publications to this channel
-
setReviewers
Sets the list of reviewers for notification publications to this channel- Parameters:
reviewers- the list of reviewers for notification publications to this channel
-
getSubscriptions
Gets the list of subscriptions to this channel- Specified by:
getSubscriptionsin interfaceNotificationChannelContract- Returns:
- the list of subscriptions to this channel
-
setSubscriptions
Sets the list of subscriptions to this channel- Parameters:
subscriptions- the list of subscriptions to this channel
-
equals
Compares the id values of each NotificationChannel object. -
hashCode
public int hashCode() -
to
Converts a mutable bo to its immutable counterpart- Parameters:
bo- the mutable business object- Returns:
- the immutable object
-
from
Converts a immutable object to its mutable counterpart- Parameters:
im- immutable object- Returns:
- the mutable bo
-