com.cleo.lexicom.scripts

Interface LogListeners

public interface LogListeners

Standalone javascript action log listeners management interface

Method Summary

Modifier and Type	Method and Description
void	add(LexiComLogListener l) Add a listener for all in-scope log events.
void	add(LexiComLogListener l, java.lang.String[] path) Add a listener for a specific source's log events.
java.lang.String[][]	list(boolean allInScope) List added javascript log listeners
LexiComLogListener	remove(java.lang.String[] path) Remove an added javascript log listener

Method Detail

add

void add(LexiComLogListener l)
  throws java.lang.Exception

Add a listener for all in-scope log events.

Limitations:
- Only one log listener can be added per script. If multiple are added, only the last one added is actually active.

Parameters:

l - a LexiComLogListener that will be notified when log events have occurred

Throws:

java.lang.Exception

add

void add(LexiComLogListener l,
         java.lang.String[] path)
  throws java.lang.Exception

Add a listener for a specific source's log events.

Limitations:
- Only one log listener can be added per script. If multiple are added, only the last one added is actually active.

Parameters:

l - a LexiComLogListener that will be notified when log events have occurred

path - the alias path to be listened, which must be in the same host tree branch as the standalone action (or below).

Throws:

java.lang.Exception

list

java.lang.String[][] list(boolean allInScope)
                   throws java.lang.Exception

List added javascript log listeners

Parameters:

allInScope - true if all of the in-scope entries should be listed; false if just the entries added by this javascript should be listed

Returns:

list of javascript action alias paths

Throws:

java.lang.Exception

remove

LexiComLogListener remove(java.lang.String[] path)
                   throws java.lang.Exception

Remove an added javascript log listener

Parameters:

path - the alias path of the javascript action to be removed

Returns:

the javascript log listener removed

Throws:

java.lang.Exception