com.ibm.di.config.interfaces
Interface ExposedProperty
- All Superinterfaces:
- BaseConfiguration, java.io.Serializable
- All Known Implementing Classes:
- ExposedPropertyImpl
public interface ExposedProperty
- extends BaseConfiguration
This interface is used with the SolutionInterface to define exposed
properties.
Field Summary |
static java.lang.String |
DENY_ALL
Property name used to denote that all properties in a storename are not
exposed |
static java.lang.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 |
CHILD_PATH_SEPARATOR, 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, SEARCH_SUBSTRING, SUBTREE |
Method Summary |
java.lang.String |
getCategory()
Returns the category for this property |
java.lang.String |
getLabel()
Optional label used by UI applications (use getUserComment() for
tooltips) |
java.lang.String |
getPropertyName()
Returns the property name |
java.lang.String |
getStoreName()
Returns the store name. |
void |
setCategory(java.lang.String category)
Changes the category for this property |
void |
setLabel(java.lang.String label)
Sets the label for this exposed property |
void |
setPropertyName(java.lang.String propertyName)
Sets the name of the exposed property |
void |
setStoreName(java.lang.String storeName)
Sets the store name to which the exposed property applies. |
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration |
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten |
DENY_ALL
static final java.lang.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 java.lang.String PERMIT_ALL
- Property name used to denote that all properties in a storename are
exposed
- See Also:
- Constant Field Values
getCategory
java.lang.String getCategory()
- Returns the category for this property
- Returns:
- the category
getPropertyName
java.lang.String getPropertyName()
- Returns the property name
- Returns:
- property name
getStoreName
java.lang.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
java.lang.String getLabel()
- Optional label used by UI applications (use getUserComment() for
tooltips)
- Returns:
- tooltip
setCategory
void setCategory(java.lang.String category)
- Changes the category for this property
- Parameters:
category
-
setPropertyName
void setPropertyName(java.lang.String propertyName)
- Sets the name of the exposed property
- Parameters:
propertyName
- The exposed property name
setStoreName
void setStoreName(java.lang.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(java.lang.String label)
- Sets the label for this exposed property
- Parameters:
label
- Text used by UI applications