All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.eNetwork.beans.HOD.MacroIOProvider
- public interface MacroIOProvider
MacroIOProvider is an interface that contains the callback methods
to store and retrieve macros for MacroManager. MacroManager does not
provide for the persistent storage of macros. MacroManager depends on the object that is
using the MacroIOProvider interface to provide persistent storage of macros.
To ensure MacroManager's internal consistency, only one listener can attach
to it at a time.
- See Also:
- MacroManager
-
getMacro(String)
- Retrieves a macro from persistent storage.
-
listMacros()
- Returns a list of all the macros in persistent storage.
-
putMacro(Properties)
- Saves a macro to persistent storage.
-
removeMacro(String)
- Deletes a macro from persistent storage.
putMacro
public abstract void putMacro(Properties p)
- Saves a macro to persistent storage. The macro is supplied in the form of
a property which contains the macro name, description, and source code text.
- Parameters:
- p - A properties object representing the macro to be saved.
- See Also:
- getMacro
getMacro
public abstract Properties getMacro(String name)
- Retrieves a macro from persistent storage. The macro name is supplied and
the macro is returned in the form of a properties object which
contains the macro name, description, and source code text.
- Parameters:
- name - String containing the name of the macro to be retrieved.
- See Also:
- putMacro
removeMacro
public abstract void removeMacro(String name)
- Deletes a macro from persistent storage.
- Parameters:
- name - String containing the name of the macro to be deleted.
listMacros
public abstract Vector listMacros()
- Returns a list of all the macros in persistent storage. The returned
Vector should contain a set of Property objects, each of which contains
(at a minimum) a macro name and description. The Property objects
do not need to (but can) contain the macro source code text. The
MacroManager issues a getMacro() call to retrieve the macro source
text when required.
- See Also:
- getMacro
All Packages Class Hierarchy This Package Previous Next Index