com.sas.edir.delivery
Interface Channel

All Superinterfaces:

Caching, Entity, EntityCollection, KeywordEntity, KeywordEntityCollection, TrackedObject, TrackedObjectCollection

public interface Channel

extends KeywordEntityCollection

A channel is an enterprise entity that contains a collection of related information. A channel provides:

• Access to channel properties: Description, Name, Subject.
• Access to channel iterations: Archive, Keyword, Subscriber.

Version:

1.0

Author:

SAS

Fields inherited from interface com.sas.edir.Entity

PROPERTY_CHANGED, SUBPROPERTY_CHANGED

Method Summary

void	addSubscriber(Subscriber subscriber) Adds a subscriber to this channel.
java.util.Iterator	archiveIterator() Returns an iteration of all the archives contained in this channel.
java.util.ListIterator	archiveIterator(java.util.Comparator compare) Returns a sorted iteration of all the archives contained in this channel.
java.lang.String	getDefaultComparatorClassName() This attribute determines the class that contains the default comparator, identified by the DefaultComparatorEntry attribute, used to sort the channels archives.
java.lang.String	getDefaultComparatorEntry() This attribute determines the default comparator definition, in the class defined by the DefaultComparatorClassName attribute, used to sort the channels archives.
boolean	getShowExpiredArchives() This attribute is informs the channel whether it should display expired archives.
java.lang.String	getSubject() Returns this channel's subject.
boolean	isGroupSubscription(DeliveryUser user) flags if a user is subscribed to this channel through a group
boolean	isGroupSubscription(Subscriber subscriber) flags if a user is subscribed to this channel through a group
boolean	isSubscription() Returns a flag that gets set if this channel was created by a subscription filter.
boolean	isSubscription(DeliveryUser user) flags if any of the subscriber identities in a DeliveryUser are subscribed to this channel.
boolean	isSubscription(Subscriber subscriber) flags if a user is subscribed to this channel
void	removeSubscriber(Subscriber subscriber) Removes a subscriber from this channel.
void	setArchivesDirty() Force a refresh of the archives contained by this channel.
void	setDefaultComparatorClassName(java.lang.String className) This attribute determines the class that contains the default comparator, identified by the DefaultComparatorEntry attribute, used to sort the channels archives.
void	setDefaultComparatorEntry(java.lang.String entryName) This attribute determines the default comparator definition, in the class defined by the DefaultComparatorClassName attribute, used to sort the channels archives.
void	setShowExpiredArchives(boolean show) This attribute is informs the channel whether it should display expired archives.
void	setShowExpiredArchives(java.lang.String show) This attribute is informs the channel whether it should display expired archives.
void	setSubject(java.lang.String subject) Sets this channel's subject.
void	setSubscription(boolean subscription) Sets the flag that indicates the user who created this channel is subscribed.
java.util.ListIterator	subscriberGroupsIterator() Returns a ListIterator of subscriber groups
java.util.Iterator	subscriberIterator() Returns an iteration of all this channel's subscribers.
java.util.ListIterator	subscriberIterator(java.util.Comparator compare) Returns a sorted iteration of all this channel's subscribers.
java.util.Iterator	subscriberNameIterator() Return an Iterator of subscriber names

Methods inherited from interface com.sas.edir.TrackedObjectCollection

getDescription, getName, iterator, listIterator, listIterator, setDescription, setName

Methods inherited from interface com.sas.edir.TrackedObject

getTrackingId, getUserData, setUserData

Methods inherited from interface com.sas.edir.Entity

addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass

Methods inherited from interface com.sas.edir.Caching

edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore

Methods inherited from interface com.sas.edir.KeywordEntity

addKeyword, keywordIterator, keywordIterator, removeKeyword, setKeywords

Method Detail

setArchivesDirty

public void setArchivesDirty()

Force a refresh of the archives contained by this channel.

archiveIterator

public java.util.Iterator archiveIterator()

Returns an iteration of all the archives contained in this channel.

Returns:

An Archive iteration.

archiveIterator

public java.util.ListIterator archiveIterator(java.util.Comparator compare)

Returns a sorted iteration of all the archives contained in this channel.

Parameters:

comparator - A Comparator for sorting, or null for no sorting.

Returns:

An Archive iteration.

getSubject

public java.lang.String getSubject()

Returns this channel's subject.

Returns:

The subject.

setSubject

public void setSubject(java.lang.String subject)

Sets this channel's subject.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

subject - The subject.

subscriberIterator

public java.util.Iterator subscriberIterator()

Returns an iteration of all this channel's subscribers.

Returns:

A Subscriber iteration.

subscriberIterator

public java.util.ListIterator subscriberIterator(java.util.Comparator compare)

Returns a sorted iteration of all this channel's subscribers.

Parameters:

comparator - A Comparator for sorting, or null for no sorting.

Returns:

A Subscriber iteration.

addSubscriber

public void addSubscriber(Subscriber subscriber)

Adds a subscriber to this channel.

Parameters:

subscriber - The subscriber to add.

removeSubscriber

public void removeSubscriber(Subscriber subscriber)

Removes a subscriber from this channel.

Parameters:

subscriber - The subscriber to remove.

isGroupSubscription

public boolean isGroupSubscription(Subscriber subscriber)

flags if a user is subscribed to this channel through a group

Parameters:

subscriber - The subscriber

Returns:

true if a subscriber's group is subscribed to this channel

isGroupSubscription

public boolean isGroupSubscription(DeliveryUser user)

flags if a user is subscribed to this channel through a group

Parameters:

user - The delivery user to look up

Returns:

true if a delivery user's group is subscribed to this channel

isSubscription

public boolean isSubscription(Subscriber subscriber)

flags if a user is subscribed to this channel

Parameters:

subscriber - The subscriber

Returns:

true if user is subscribed, false otherwise

isSubscription

public boolean isSubscription(DeliveryUser user)

flags if any of the subscriber identities in a DeliveryUser are subscribed to this channel.

Returns:

true if the user is subscribed

isSubscription

public boolean isSubscription()

Returns a flag that gets set if this channel was created by a subscription filter. This should be deprecated in favor of the other subscription tests.

setSubscription

public void setSubscription(boolean subscription)

Sets the flag that indicates the user who created this channel is subscribed. This should be deprecated in favor of using the tests that take a subscriber or group.

subscriberNameIterator

public java.util.Iterator subscriberNameIterator()

Return an Iterator of subscriber names

subscriberGroupsIterator

public java.util.ListIterator subscriberGroupsIterator()

Returns a ListIterator of subscriber groups

getShowExpiredArchives

public boolean getShowExpiredArchives()

This attribute is informs the channel whether it should display expired archives. By default it will not display them.

Returns:

true if the archiveIterator will show expired archives, false otherwise.

setShowExpiredArchives

public void setShowExpiredArchives(boolean show)

This attribute is informs the channel whether it should display expired archives. By default, it will not display them.

Parameters:

show - true to show expired archives, false to not show them.

setShowExpiredArchives

public void setShowExpiredArchives(java.lang.String show)

This attribute is informs the channel whether it should display expired archives. By default, it will not display them.

Parameters:

show - true to show expired archives, false to not show them.

getDefaultComparatorClassName

public java.lang.String getDefaultComparatorClassName()

This attribute determines the class that contains the default comparator, identified by the DefaultComparatorEntry attribute, used to sort the channels archives. By default the ArchivesByDescendingDate comparator in com.sas.edir.delivery.ldap.LdapChannel is used to sort archives by descending (newest to oldest) creation date.

Returns:

the class name of the comparator.

setDefaultComparatorClassName

public void setDefaultComparatorClassName(java.lang.String className)

This attribute determines the class that contains the default comparator, identified by the DefaultComparatorEntry attribute, used to sort the channels archives. By default the ArchivesByDescendingDate comparator in com.sas.edir.delivery.ldap.LdapChannel is used to sort archives by descending (newest to oldest) creation date.

Parameters:

classname - the fully qualified classname of a class containing comparators.

getDefaultComparatorEntry

public java.lang.String getDefaultComparatorEntry()

This attribute determines the default comparator definition, in the class defined by the DefaultComparatorClassName attribute, used to sort the channels archives. By default the ArchivesByDescendingDate comparator in com.sas.edir.delivery.ldap.LdapChannel is used to sort archives by descending (newest to oldest) creation date.

Returns:

the name of the comparator.

setDefaultComparatorEntry

public void setDefaultComparatorEntry(java.lang.String entryName)

This attribute determines the default comparator definition, in the class defined by the DefaultComparatorClassName attribute, used to sort the channels archives. By default the ArchivesByDescendingDate comparator in com.sas.edir.delivery.ldap.LdapChannel is used to sort archives by descending (newest to oldest) creation date.

Parameters:

entryName - the name of the comparator entry.