com.ibm.di.config.interfaces
Interface SolutionInterface

All Superinterfaces:

BaseConfiguration, ContainerConfig, Serializable

All Known Implementing Classes:

SolutionInterfaceImpl

public interface SolutionInterface
extends ContainerConfig

This interface provides access to the Solution interface settings of a configuration. Most of these elements are used to define external aspects of a configuration such as which assemblylines and properties are visible/editable by a user at runtime.

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

BaseConfiguration	addExposedAssemblyLine(String name) Convenience method to create a BaseConfiguration object in the exposed assemblylines container.
ExposedProperty	addExposedProperty(String propertyName, String storeName) Convenience method to create an ExposedProperty object in the exposed properties container.
ContainerConfig	getExposedAssemblyLines() Returns a container of assemblyline names that are exposed by this solution.
ContainerConfig	getExposedProperties() Returns a container of ExposedProperty objects.
ExposedProperty	getExposedProperty(String propertyName, String storeName) Returns the ExposedProperty object using name and storename
String	getHealthAssemblyLine() Returns the name of the health assemblyline.
int	getHealthPollInterval() Returns the poll interval for the health assemblyline.
String	getInstanceID() Returns the instance ID for this configuration or null if none is defined.
List	getPropertyCategoryNames() Convenience method that returns a list of unique category names found in the exposed properties container.
List	getPropertyStoreNames() Convenience method that returns a list of unique store names found in the exposed properties container.
void	setHealthAssemblyLine(String name) Sets the name of the health assemblyline for this configuration (null or empty string to clear).
void	setHealthPollInterval(int seconds) Sets the poll interval for the health assemblyline.
void	setInstanceID(String id) Sets the instance ID for this configuration or null if none is defined.

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

addConfig, containsConfig, getConfig, getConfig, getConfig, getConfigurations, getInheritedConfigurations, indexOf, indexOf, insertConfig, moveConfig, moveConfig, moveConfig, removeConfig, removeConfig, removeConfig, size

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, toEntry, updateInheritsFrom, willFlatten

Method Detail

getHealthAssemblyLine

String getHealthAssemblyLine()

Returns the name of the health assemblyline. The return value is null if no assemblyline is configured.

Returns:

The name of the Health assemblyline

setHealthAssemblyLine

void setHealthAssemblyLine(String name)

Sets the name of the health assemblyline for this configuration (null or empty string to clear).

Parameters:

name - The name of the Health assemblyline (using empty string will translate to null value).

getExposedAssemblyLines

ContainerConfig getExposedAssemblyLines()

Returns a container of assemblyline names that are exposed by this solution. Each child of the list is a BaseConfiguration object where the name is set to that of the assemblyline. The BaseConfiguration object for each assemblyline can be used to hold additional custom information about each AL.

Returns:

ContainerConfig of assemblyline names (String values)

addExposedAssemblyLine

BaseConfiguration addExposedAssemblyLine(String name)
                                         throws Exception

Convenience method to create a BaseConfiguration object in the exposed assemblylines container. Use getExposedAssemblyLines().getConfig()/removeConfig() etc to manipulate contents. If an assemblyline with that name is already defined the current configuration is returned.

Parameters:

name - Name of the AL to expose

Returns:

The new/current configuration

Throws:

Exception

getExposedProperty

ExposedProperty getExposedProperty(String propertyName,
                                   String storeName)

Returns the ExposedProperty object using name and storename

Parameters:

propertyName - The propery name.

storeName - The store name.

Returns:

Returns the ExposedProperty object using name and store name.

getExposedProperties

ContainerConfig getExposedProperties()

Returns a container of ExposedProperty objects.

Returns:

ContainerConfig of ExposedProperty objects.

addExposedProperty

ExposedProperty addExposedProperty(String propertyName,
                                   String storeName)
                                   throws Exception

Convenience method to create an ExposedProperty object in the exposed properties container. Use getExposedProperties().getConfig()/removeConfig() etc to manipulate contents. If a property with that name/storename is already defined the current configuration is returned. When creating a new ExposedProperty object the concatenation of "propertyName.propertyStore" is used to generate a unique name for the object.

Parameters:

propertyName - Name of the AL to expose.

storeName - Name of the store.

Returns:

The new/current configuration

Throws:

Exception

getPropertyCategoryNames

List getPropertyCategoryNames()

Convenience method that returns a list of unique category names found in the exposed properties container.

Returns:

List of category names (String values)

getPropertyStoreNames

List getPropertyStoreNames()

Convenience method that returns a list of unique store names found in the exposed properties container.

Returns:

List of store names (String values)

getInstanceID

String getInstanceID()

Returns the instance ID for this configuration or null if none is defined.

setInstanceID

void setInstanceID(String id)

Sets the instance ID for this configuration or null if none is defined.

Parameters:

id - The config instance id or null

getHealthPollInterval

int getHealthPollInterval()

Returns the poll interval for the health assemblyline.

Returns:

The poll interval seconds or -1 if not configured

setHealthPollInterval

void setHealthPollInterval(int seconds)

Sets the poll interval for the health assemblyline.

Parameters:

seconds - The poll interval in seconds