public interface WmTemplateDescriptor extends WmDescriptor
WmAdapterService.fillWmTemplateDescriptor(com.wm.adk.metadata.WmTemplateDescriptor, java.util.Locale)
, and then the
Integration Server fills the descriptor by calling the following method:
fillWmTemplateDescriptor(WmTemplateDescriptor d, Locale l);
Glossary:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INPUT_EXPRESSIONS
ResourceDomain name for input expressions.
|
static java.lang.String |
INPUT_FIELD_NAMES
ResourceDomain name for input signature field names.
|
static java.lang.String |
OUTPUT_FIELD_NAMES
ResourceDomain name for output signature field names.
|
Modifier and Type | Method and Description |
---|---|
void |
createFieldMap(java.lang.String[] members,
boolean variable)
Creates a field map.
|
void |
createFieldMap(java.lang.String[] members,
boolean variable,
boolean fillAll)
Creates a field map with the
fillAll flag setting option. |
void |
createTuple(java.lang.String[] members)
Creates a tuple containing a specified list of sequence parameters.
|
void |
disableAppendAll(java.lang.String fieldMap)
Disables the "append all" button for a field map in the Adapter Service/Notification
Editors.
|
void |
setKey(java.lang.String name)
Sets the key flag for a parameter.
|
void |
setKey(java.lang.String name,
boolean key)
Marks a parameter as key, when
key is set to true . |
void |
setMultiline(java.lang.String name)
Sets the multi-line flag for a parameter.
|
void |
setMultiline(java.lang.String name,
boolean multiline)
Marks a parameter as multi-line, when
multiline is set to true . |
void |
setResourceDomain(java.lang.String name,
java.lang.String resourceDomainName,
java.lang.String[] dependencies)
Sets the resourceDomain and dependencies for a parameter.
|
void |
setResourceDomain(java.lang.String name,
java.lang.String resourceDomainName,
java.lang.String[] dependencies,
java.lang.String useParam)
Sets the resourceDomain and dependencies for a parameter with use flags.
|
void |
setTreeChooser(java.lang.String[] parameters,
java.lang.String delimiter)
Creates a tree chooser widget for the parameters specified.
|
void |
setTreeMap(java.lang.String parameter,
java.lang.String delimiters)
Creates a tree control on a single field (column) in a field map.
|
createGroup, getDescription, getDisplayName, getFeatureValue, getName, isPassFullPipeline, isShowConnectionName, isSignatureWrapped, setDescription, setDescription, setDescriptions, setDisplayName, setDisplayName, setFeatureValue, setGroupName, setHidden, setHidden, setMaxSeqLength, setMaxStringLength, setMinSeqLength, setMinSeqLength, setMinStringLength, setName, setPassFullPipeline, setPassword, setPassword, setRequired, setRequired, setShowConnectionName, setSignatureWrapped, setValidValues
static final java.lang.String INPUT_EXPRESSIONS
StatementFormat
.
Examples of values are,
setResourceDomain(java.lang.String, java.lang.String, java.lang.String[])
). All of the dependencies except the last one are
used to generate a suggested signature field name. The last dependency must point
to a parameter with a field type. The Adapter Service/Notification Editors use this
information to populate a choice with values such as "%field1%" and to create fields
in the input signature with the appropriate types.static final java.lang.String INPUT_FIELD_NAMES
static final java.lang.String OUTPUT_FIELD_NAMES
void createFieldMap(java.lang.String[] members, boolean variable) throws AdapterException
variable
is set to true, the number of
fields that appear in the Adapter Service Editor or the Adapter Notification Editor
can vary. The editors provide several GUI elements that enable users to add and delete
fields. When variable
is set to false (non-variable field map),
fillAll
is always set to true. When variable
is set to true
(variable field map), fillAll
defaults to false.members
- an ordered list of field map membersvariable
- set to true to create a variable field mapAdapterException
- if any of the field map members do not existvoid createFieldMap(java.lang.String[] members, boolean variable, boolean fillAll) throws AdapterException
fillAll
flag setting option. Include the names
of all of the parameters you want in the field map in the members array. When
variable
is set to true, the number of fields that appear in the Adapter
Service Editor or the Adapter Notification Editor can vary. The editors provide several
GUI elements that enable users to add and delete fields.
When variable
is set to false (non-variable field map), fillAll
is always set to true. When variable
is set to true (variable field map) and
fillAll
is set to true, the editor will fill in all the available data.
When variable
is set to true (variable field map) and fillAll
is set to false, the user can add one row at a time using the editor.members
- an ordered list of field map membersvariable
- set to true to create a variable field mapfileAll
- set to true to fill in all the available dataAdapterException
- if any of the field map members do not existvoid createTuple(java.lang.String[] members) throws AdapterException
Note that there are several specific conditions which must be met in order for the tuple feature to function properly. Please refer to the ADK User's Guide for details.
members
- an ordered list of parameter namesAdapterException
- if any of the tuple members does not existvoid disableAppendAll(java.lang.String fieldMap) throws AdapterException
fieldMap
- the name of field map (the first member of field map)AdapterException
- if the specified field map does not existvoid setKey(java.lang.String name) throws AdapterException
name
- the name of the parameterAdapterException
- if the parameter does not existvoid setKey(java.lang.String name, boolean key) throws AdapterException
key
is set to true
.
This method only applies to sequence parameters. A sequence parameter that is
a key requires unique values for each sequence entry.name
- the name of the parameterkey
- set to true to make the parameter a key; otherwise, set to false.AdapterException
- if the parameter does not existvoid setMultiline(java.lang.String name) throws AdapterException
name
- the name of the parameterAdapterException
- if the parameter does not existvoid setMultiline(java.lang.String name, boolean multiline) throws AdapterException
multiline
is set to true
.
For parameters that are marked as multi-line, the Adapter Service/Notification
Editors will present a GUI widget that allows users to enter multiple lines of text.name
- the name of the parametermultiline
- set to true to use a multiline GUI element; otherwise, set to false.AdapterException
- if the parameter does not existvoid setResourceDomain(java.lang.String name, java.lang.String resourceDomainName, java.lang.String[] dependencies) throws AdapterException
name
- the name of the parameterresourceDomainName
- the name of the resourceDomain. The resourceDomainName must be
registered using the
WmManagedConnection.registerResourceDomain(com.wm.adk.metadata.WmAdapterAccess)
method.dependencies
- the list of dependencies, which must be the names of parameters.
Prefix the dependency parameter with an asterisk (*
)
if the dependency parameter contains a sequence, and you need all
values of the sequence.AdapterException
- if one or more of the values is not a parameter, or if the
resourceDomain is not registered in the adapter.void setResourceDomain(java.lang.String name, java.lang.String resourceDomainName, java.lang.String[] dependencies, java.lang.String useParam) throws AdapterException
boolean[]
parameter as the final argument to this method.name
- the name of the parameterresourceDomainName
- the name of the resourceDomain. The resourceDomainName must
be registered using the
WmManagedConnection.registerResourceDomain(com.wm.adk.metadata.WmAdapterAccess)
method.dependencies
- the list of dependencies, which must be the names of parameters.
Prefix the dependency parameter with an asterisk (*
)
if the dependency parameter contains a sequence, and you need all
values of the sequence.useParm
- the name of a boolean[]
parameter containing the use flags.AdapterException
- if one or more of the values is not a parameter, or if the
resourceDomain is not registered in the adapter.void setTreeChooser(java.lang.String[] parameters, java.lang.String delimiter) throws AdapterException
For example, suppose you have three parameters "paramA", "paramB", and "paramC", and their respective values are "valueA", "valueB", and "valueC". If you append those values with delimiters such as "valueA.valueB.valueC", the editor will display them as follows:
valueA |_valueB |_valueC
members
- an ordered list of parameters to show in the treedelimiter
- to be used when combining values from multiple parameters for displayAdapterException
- if any of the tree parameters do not existvoid setTreeMap(java.lang.String parameter, java.lang.String delimiters) throws AdapterException
For example, a parameter with the value "A.B.C" will become a tree with the following structure:
A |_B |_C
parameter
- the name of the parameter to use for the tree structuredelimiters
- the list of characters to use for splitting a single parameter into
multiple valuesAdapterException
- if the parameter doesn't exist or is not the first column of
a field map.
Copyright © 2003 - 2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.