Adapter Development Kit 9.12 | webMethods Adapter Development Kit Documentation | webMethods Adapter Development Kit Installation and User’s Documentation | Using the Services for Managing Namespace Nodes | Listener Services | wm.art.dev.listener:fetchListenerTemplateMetadata
 
wm.art.dev.listener:fetchListenerTemplateMetadata
This service fetches all metadata supported by the listener template for a specified connection alias and listener template class path.
This service takes a valid connection alias and listener template class path, and returns an array of templateProperties structure each containing attributes such as systemName, parameterType, defaultValue, and isRequired.
Input Parameters
Name
Description
connectionAlias
String. Required. Name of an existing connection in the format: folder:node.
listenerTemplate
String. Required. Fully qualified pathname of listener template class.
Output Parameters
Name
Description
description
String. Required. Listener template description. Same as the value returned by WmDescriptor.getDisplayName method.
displayName
String. Required. Listener template name displayed. Same as the value returned by WmDescriptor.getDescription method.
listAllConnection
String. Default template metadata
templateURL
String. Required. URL of the online help page for the listener.
requiresConnection
Boolean. Specifies whether the listener requires a connection.
indexMaps[i]
IData[]. Required. An i-dimensioned array of field maps.
mapName
String. Field map name.
isVariable
Boolean. Specifies whether the field map is variable length.
disableAppendAll
Boolean. Disables all the buttons used for appending the rows for a field map in the Adapter Service Editor.
templateProperties[n]
IData[]. Required. An n-dimensioned array of properties.
systemName
String. Required. Internal property name.
displayName
String. Required. External displayable property name.
description
String. Required. Description of the property.
parameterType
String. Required. Data type of property.
*The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean.
*Arrays are not supported.
groupURL
String. URL of the group's help page.
groupName
String. Name of the group to which the property belongs.
tupleName
String. Name of the tuple to which the property belongs.
treeName
String. Name of the tree to which the property belongs.
treeDelimiter
String. Delimiter character used in the tree.
resourceDomain
String. Resource domain name to which the property belongs.
treeView
String. Property name for which values are displayed in the tree structure for selection.
defaultValue
String. Default value of the property.
isRequired
Boolean. Specifies whether the property is required.
isHidden
Boolean. Specifies whether the property is displayable.
isReadOnly
Boolean. Specifies whether the property can be modified.
isFill
Boolean. Specifies whether the editors should pre-fill the property.
isPassword
Boolean. Specifies whether the property is a password.
isMultiline
Boolean. Specifies whether the property traverses multiple lines.
isKey
Boolean. Specifies whether the property is a key field.
minSeqLength
String. Lower bound of the sequence.
maxSeqLength
String. Upper bound of the sequence.
minStringLength
String. Minimum string length.
maxStringLength
String. Maximum string length.
useParam
String. Specifies whether the property is available for use.