com.canto.cumulus.prefs

Class TableSubscriptionConfiguration

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.TableSubscriptionConfiguration

public class TableSubscriptionConfiguration
extends BaseManager

This class stores the subscription configuration for a single table.

Since:

9.2

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
CatalogGUIDList	getFieldRestrictionFields() Returns the list of fields which should be used to determine whether an item change should result in a notification.
boolean	isEnabled() Returns whether this table is enabled for subscriptions.
boolean	isFieldRestrictionEnabled() Returns whether this table should send subscription notifications only in case one of a list of specified fields has changed.
void	setEnabled(boolean enabled) Configures whether this table is enabled for subscriptions.
void	setFieldRestrictionEnabled(boolean enabled) Configures whether this table should send subscription notifications only in case one of a list of specified fields has changed.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isEnabled

public boolean isEnabled()

Returns whether this table is enabled for subscriptions.

Returns:

whether this table is enabled for subscriptions

setEnabled

public void setEnabled(boolean enabled)

Configures whether this table is enabled for subscriptions.

Parameters:

enabled - true if this table is enabled for subscriptions, false otherwise

isFieldRestrictionEnabled

public boolean isFieldRestrictionEnabled()

Returns whether this table should send subscription notifications only in case one of a list of specified fields has changed.

Returns:

whether this table should send subscription notifications only in case one of a list of specified fields has changed

setFieldRestrictionEnabled

public void setFieldRestrictionEnabled(boolean enabled)

Configures whether this table should send subscription notifications only in case one of a list of specified fields has changed.

Parameters:

enabled - specifies whether this table should send subscription notifications only in case one of a list of specified fields has changed

getFieldRestrictionFields

public CatalogGUIDList getFieldRestrictionFields()

Returns the list of fields which should be used to determine whether an item change should result in a notification.

Returns:

list of fields which should be used to determine whether an item change should result in a notification