com.ibm.di.config.interfaces
Interface CallConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

CallConfigImpl

public interface CallConfig
extends BaseConfiguration

Specifies the basic methods for configuring an object through which calls are performed

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

CallParamConfig	getCallParameter(Object name) Gets a named CallParamConfig object
List	getCallParameters() Gets the callParameters attribute of the CallConfig object
CallParamConfig	newCallParameter(Object name) Creates a new CallParamConfig and adds it to this configuration.
void	removeCallParameter(CallParamConfig param) Removes a CallParamConfig object from this config.
void	setCallParameter(CallParamConfig param) Sets a name CallParamConfig object

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

getCallParameters

List getCallParameters()

Gets the callParameters attribute of the CallConfig object

Returns:

The callParameters value

getCallParameter

CallParamConfig getCallParameter(Object name)

Gets a named CallParamConfig object

Parameters:

name - The name of the CallParamConfig object

Returns:

The callParameter value

setCallParameter

void setCallParameter(CallParamConfig param)

Sets a name CallParamConfig object

Parameters:

param - The new callParameter value

removeCallParameter

void removeCallParameter(CallParamConfig param)

Removes a CallParamConfig object from this config.

Parameters:

param - The CallParamConfig object to remove

newCallParameter

CallParamConfig newCallParameter(Object name)
                                 throws Exception

Creates a new CallParamConfig and adds it to this configuration.

Parameters:

name - Call param name

Returns:

The new CallParamConfig object

Throws:

Exception - if the operation does not succeed