com.ibm.di.config.interfaces
Interface MetamergeFolder

All Superinterfaces:

BaseConfiguration, Serializable

All Known Subinterfaces:

MetamergeConfig

All Known Implementing Classes:

MetamergeConfigFS, MetamergeConfigImpl, MetamergeConfigXML, MetamergeFolderImpl, PropertyManagerImpl

public interface MetamergeFolder
extends BaseConfiguration

This interface describes the methods provided by a folder object. A folder is a container for other folders and leaf configuration objects.

Field Summary

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SUBTREE

Method Summary

MetamergeFolder	createFolder(Object name) This method creates a sub-folder in this folder with the given name.
String[]	getNames() This method returns an array of names contained in this folder.
Enumeration	list() Returns a list of javax.naming.Binding objects for each of this folders child entries.

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Method Detail

list

Enumeration list()
                 throws Exception

Returns a list of javax.naming.Binding objects for each of this folders child entries. The Binding object contains the name of the object as well as the object itself.

Returns:

Enumeration of Binding objects

Throws:

Exception

getNames

String[] getNames()
                  throws Exception

This method returns an array of names contained in this folder.

Returns:

The names value

Throws:

Exception

createFolder

MetamergeFolder createFolder(Object name)
                             throws Exception

This method creates a sub-folder in this folder with the given name.

Parameters:

name - Name of sub-folder

Returns:

The MetamergeFolder object representing the new sub-folder

Throws:

Exception