com.ibm.di.config.interfaces
Interface ExposedProperty

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

ExposedPropertyImpl

public interface ExposedProperty
extends BaseConfiguration

This interface is used with the SolutionInterface to store exposed properties.

Field Summary

static String	DENY_ALL Property name used to denote that all properties in a storename are not exposed
static String	PERMIT_ALL Property name used to denote that all properties in a storename are exposed

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

String	getCategory() Returns the category for this property
String	getLabel() Optional label used by UI applications (use getUserComment() for tooltips)
String	getPropertyName() Returns the property name
String	getStoreName() Returns the store name.
void	setCategory(String category) Changes the category for this property
void	setLabel(String label) Sets the label for this exposed property
void	setPropertyName(String propertyName) Sets the name of the exposed property
void	setStoreName(String storeName) Sets the store name to which the exposed property applies.

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

Field Detail

DENY_ALL

static final String DENY_ALL

Property name used to denote that all properties in a storename are not exposed

See Also:

Constant Field Values

PERMIT_ALL

static final String PERMIT_ALL

Property name used to denote that all properties in a storename are exposed

See Also:

Constant Field Values

Method Detail

getCategory

String getCategory()

Returns the category for this property

Returns:

the category

getPropertyName

String getPropertyName()

Returns the property name

Returns:

property name

getStoreName

String getStoreName()

Returns the store name. A property may be exposed without a store name in which case it applies to the first store name with that property.

Returns:

store name or null if not defined

getLabel

String getLabel()

Optional label used by UI applications (use getUserComment() for tooltips)

Returns:

tooltip

setCategory

void setCategory(String category)

Changes the category for this property

Parameters:

category -

setPropertyName

void setPropertyName(String propertyName)

Sets the name of the exposed property

Parameters:

propertyName - The exposed property name

setStoreName

void setStoreName(String storeName)

Sets the store name to which the exposed property applies. Can be null to denote the first property store with this name.

Parameters:

storeName - The name of the property store or null for any property store

setLabel

void setLabel(String label)

Sets the label for this exposed property

Parameters:

label - Text used by UI applications