com.sssw.cm.event.api
Interface EbiStateChangeProducer

All Superinterfaces:

EbiStateChangeProducer

All Known Subinterfaces:

EbiContentManager, EbiContentMgmtDelegate

public interface EbiStateChangeProducer

extends EbiStateChangeProducer

Provides a Content Management-specific interface for event generation and event listener registration.

Method Summary

boolean	addCategoryStateChangeListener(EbiStateChangeListener listener) Adds a state change listener as one interested in all events that occur on categories.
boolean	addDocumentStateChangeListener(EbiStateChangeListener listener) Adds a state change listener as one interested in all events that occur on documents.
boolean	addFolderStateChangeListener(EbiStateChangeListener listener) Adds a state change listener as one interested in all events that occur on folders.
boolean	addStateChangeListener(BitSet events, EbiDirectoryEntry entry, int depth, EbiStateChangeListener listener) Adds a state change listener for specific events on a specific CM directory entry specified by its path.
boolean	addVetoableCategoryStateChangeListener(EbiVetoableStateChangeListener listener) Adds a state change listener as one interested in all events that occur on categories.
boolean	addVetoableDocumentStateChangeListener(EbiVetoableStateChangeListener listener) Adds a vetoable state change listener as one interested in all events that occur on documents.
boolean	addVetoableFolderStateChangeListener(EbiVetoableStateChangeListener listener) Adds a state change listener as one interested in all events that occur on folders.
boolean	addVetoableStateChangeListener(BitSet events, EbiDirectoryEntry entry, int depth, EbiVetoableStateChangeListener listener) Adds a vetoable state change listener for specific events on a specific CM directory entry specified by its path.

Methods implemented from interface com.sssw.fw.event.api.EbiStateChangeProducer

addStateChangeListener, addStateChangeListener, addVetoableStateChangeListener, addVetoableStateChangeListener, fireStateChange, fireVetoableStateChange, getListeners, getScpDescription, getScpLog, getVetoableListeners, hasListeners, hasVetoableListeners, removeStateChangeListener, removeVetoableStateChangeListener, setScpDescription, setScpLog

Method Detail

addStateChangeListener

public boolean addStateChangeListener(BitSet events,
                                      EbiDirectoryEntry entry,
                                      int depth,
                                      EbiStateChangeListener listener)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Adds a state change listener for specific events on a specific CM directory entry specified by its path.

Parameters:

events - the set of events the listener is interested in; pass in null to signify "all events"

entry - the directory entry

depth - specifies whether the registration is for the element named by path (depth = 0), the element and its immediate children (depth = 1), or some other depth of tree; a depth value of -1 corresponds to an "infinite depth", meaning the entire subtree rooted at the path

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addVetoableStateChangeListener

public boolean addVetoableStateChangeListener(BitSet events,
                                              EbiDirectoryEntry entry,
                                              int depth,
                                              EbiVetoableStateChangeListener listener)
                                       throws EboUnrecoverableSystemException,
                                              EboSecurityException

Adds a vetoable state change listener for specific events on a specific CM directory entry specified by its path.

Parameters:

events - the set of events the listener is interested in; pass in null to signify "all events"

entry - the directory entry

depth - specifies whether the registration is for the element named by path (depth = 0), the element and its immediate children (depth = 1), or some other depth of tree; a depth value of -1 corresponds to an "infinite depth", meaning the entire subtree rooted at the path

listener - the vetoable listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addDocumentStateChangeListener

public boolean addDocumentStateChangeListener(EbiStateChangeListener listener)

Adds a state change listener as one interested in all events that occur on documents.

Parameters:

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addVetoableDocumentStateChangeListener

public boolean addVetoableDocumentStateChangeListener(EbiVetoableStateChangeListener listener)

Adds a vetoable state change listener as one interested in all events that occur on documents.

Parameters:

listener - the vetoable listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addFolderStateChangeListener

public boolean addFolderStateChangeListener(EbiStateChangeListener listener)

Adds a state change listener as one interested in all events that occur on folders.

Parameters:

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addVetoableFolderStateChangeListener

public boolean addVetoableFolderStateChangeListener(EbiVetoableStateChangeListener listener)

Adds a state change listener as one interested in all events that occur on folders.

Parameters:

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addCategoryStateChangeListener

public boolean addCategoryStateChangeListener(EbiStateChangeListener listener)

Adds a state change listener as one interested in all events that occur on categories.

Parameters:

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before

addVetoableCategoryStateChangeListener

public boolean addVetoableCategoryStateChangeListener(EbiVetoableStateChangeListener listener)

Adds a state change listener as one interested in all events that occur on categories.

Parameters:

listener - the listener to add

Returns:

true if the listener was added successfully, false if it had already been added before