public interface WmDescriptor
WmTemplateDescriptor
extends this interface.
Methods in this class that do not take a parameter name set attributes of an adapter service
template or adapter notification template. Methods that take a parameter name set an attribute
for an individual parameter. For example,
WmTemplateDescriptor.setDisplayName("hello")sets the display name for the service/notification to "hello", and
WmTemplateDescriptor.setDisplayName("param1", "hello");sets the display name of the parameter "param1" to "hello".
WmTemplateDescriptor
Modifier and Type | Method and Description |
---|---|
void |
createGroup(java.lang.String groupName,
java.lang.String[] groupMembers)
Creates a display group and adds the specified members to it.
|
java.lang.String |
getDescription()
Returns the description of the connection, listener, service, or notification.
|
java.lang.String |
getDisplayName()
Returns the display name of the connection, adapter service, listener, or adapter
notification.
|
java.lang.String |
getFeatureValue(java.lang.String featureName) |
java.lang.String |
getName()
Returns the system name of the connection, listener, service, or notification.
|
boolean |
isPassFullPipeline() |
boolean |
isShowConnectionName() |
boolean |
isSignatureWrapped() |
void |
setDescription(java.lang.String description)
Sets the description for the connection, listener, service, or notification, depending
on where the method is called.
|
void |
setDescription(java.lang.String name,
java.lang.String description)
Sets the description of a parameter exposed by the connection, listener, service, or
notification.
|
void |
setDescriptions(AdapterResourceBundleManager ar,
java.util.Locale locale)
This method internationalizes the metadata information.
|
void |
setDisplayName(java.lang.String displayName)
Sets the display name of the connection, listener, service, or notification.
|
void |
setDisplayName(java.lang.String name,
java.lang.String display)
Sets the display name of a parameter exposed by the connection, listener, service, or
notification.
|
void |
setFeatureValue(java.lang.String featureName,
java.lang.String featureValue) |
void |
setGroupName(java.lang.String name,
java.lang.String groupName)
Adds a parameter to a display group.
|
void |
setHidden(java.lang.String name)
Marks a parameter as hidden.
|
void |
setHidden(java.lang.String name,
boolean hidden)
Marks a parameter as hidden, when
hidden is set to true . |
void |
setMaxSeqLength(java.lang.String name,
int length)
Sets the maximum sequence length for a sequence parameter.
|
void |
setMaxStringLength(java.lang.String name,
int length)
Sets the maximum string length for a parameter value.
|
void |
setMinSeqLength(java.lang.String name,
int length)
Sets the minimum sequence length for a sequence parameter.
|
void |
setMinSeqLength(java.lang.String name,
int seqLength,
int stringLength)
Sets the minimum sequence length and string length for a parameter
that is a sequence of strings.
|
void |
setMinStringLength(java.lang.String name,
int length)
Sets the minimum string length for a parameter value.
|
void |
setName(java.lang.String name)
Sets the system name of a connection, listener, service, or notification.
|
void |
setPassFullPipeline(boolean value) |
void |
setPassword(java.lang.String name)
Sets the password flag for a parameter to true.
|
void |
setPassword(java.lang.String name,
boolean password)
Sets the password flag for a parameter to true or false.
|
void |
setRequired(java.lang.String name)
Marks a parameter as required.
|
void |
setRequired(java.lang.String name,
boolean required)
Marks a parameter as required when
required is set to true . |
void |
setShowConnectionName(boolean value) |
void |
setSignatureWrapped(boolean value) |
void |
setValidValues(java.lang.String name,
java.lang.String[] values)
Sets the list of valid values that a parameter may have.
|
void createGroup(java.lang.String groupName, java.lang.String[] groupMembers) throws AdapterException
Putting members in groups establishes order among them. Members are placed in groups in the order in which they are specified in the createGroup() method.
Groups that you add to a connection factory or listener class only appear on the Administrative interface (i.e., the adapter's Integration Server Administrator DSPs).
Groups that you add to adapter service templates or adapter notification templates only appear on the Adapter Service Editor and Adapter Notification Editor. Each group that you add to a template adds a corresponding tab in the Adapter Service Editor or Adapter Notification Editor.
groupName
- the name of the display group to creategroupMembers
- an ordered list of members in this groupAdapterException
- if any of the group's members does not existjava.lang.String getDescription()
setDescription(java.lang.String)
,
setDescriptions(com.wm.adk.i18n.AdapterResourceBundleManager, java.util.Locale)
java.lang.String getDisplayName()
getName()
.java.lang.String getFeatureValue(java.lang.String featureName)
java.lang.String getName()
setName(String)
boolean isPassFullPipeline()
boolean isShowConnectionName()
boolean isSignatureWrapped()
void setDescription(java.lang.String description)
description
- the description for the connection, listener, service, or notificationvoid setDescription(java.lang.String name, java.lang.String description) throws AdapterException
setDescriptions(AdapterResourceBundleManager, Locale)
).name
- the name of the parameterdescription
- the parameter's descriptionAdapterException
- if the parameter does not existsetDescriptions(AdapterResourceBundleManager, Locale)
void setDescriptions(AdapterResourceBundleManager ar, java.util.Locale locale) throws AdapterException
ar
- the adapter's resource bundle managerlocale
- the client localeAdapterException
- if the metadata or resource bundle setting is not correctvoid setDisplayName(java.lang.String displayName)
displayName
- the display name of the connection, listener, service, or notificationvoid setDisplayName(java.lang.String name, java.lang.String display) throws AdapterException
name
- the name of the parameterdisplayName
- the display name for the parameterAdapterException
- if the parameter does not existvoid setFeatureValue(java.lang.String featureName, java.lang.String featureValue)
void setGroupName(java.lang.String name, java.lang.String groupName) throws AdapterException
groupName
was previously created by a call to
createGroup(String, String[])
, the new parameter is appended to those
already declared in that group.name
- the name of the parametergroupName
- the name of the display groupAdapterException
- if the parameter does not existcreateGroup(String, String[])
void setHidden(java.lang.String name) throws AdapterException
name
- the name of the parameter.AdapterException
- if the parameter does not existvoid setHidden(java.lang.String name, boolean hidden) throws AdapterException
hidden
is set to true
.
Hidden parameters do not appear in tools such as the Adapter Service Editor, Adapter
Notification Editor, or Administrative DSPs.name
- the name of the parameter.hidden
- whether or not the property is hiddenAdapterException
- if the parameter does not existvoid setMaxSeqLength(java.lang.String name, int length) throws AdapterException
name
- the name of the sequence parameterlength
- maximum number of the elements in the sequence parameterAdapterException
- if the parameter does not existvoid setMaxStringLength(java.lang.String name, int length) throws AdapterException
name
- the name of the parameterlength
- the maximum string length for a parameter's valueAdapterException
- if the parameter does not existvoid setMinSeqLength(java.lang.String name, int length) throws AdapterException
name
- the name of the sequence parameterlength
- the minimum number of elements in the sequenceAdapterException
- if the parameter does not existvoid setMinSeqLength(java.lang.String name, int seqLength, int stringLength) throws AdapterException
void setMinSeqLength("resourceTables",1,1);
name
- the name of the parameterseqLength
- the minimum number of elements in the sequencestringLength
- the minimum length of any string element in the
sequenceAdapterException
- if the parameter does not existvoid setMinStringLength(java.lang.String name, int length) throws AdapterException
name
- the name of the parameterlength
- the minimum string length for the parameter's valueAdapterException
- if the parameter does not existvoid setName(java.lang.String name)
name
- the new system namevoid setPassFullPipeline(boolean value)
void setPassword(java.lang.String name) throws AdapterException
password
flag is set to true, its value will not appear
as clear text in tools such as the Adapter Service Editor, Adapter Notification Editor,
or Administrative DSPs.name
- the name of the parameterAdapterException
- if the parameter does not existvoid setPassword(java.lang.String name, boolean password) throws AdapterException
password
flag is set to true, its value will not appear
as clear text in tools such as the Adapter Service Editor, Adapter Notification Editor,
or Administrative DSPs.name
- the name of the parameterpassword
- true if name
should be treated as
a password parameter; otherwise, false.AdapterException
- if the parameter does not existvoid setRequired(java.lang.String name) throws AdapterException
name
- the name of the parameterAdapterException
- if the parameter does not existvoid setRequired(java.lang.String name, boolean required) throws AdapterException
required
is set to true
.
If a parameter is marked as required, you must supply a value for it in tools such as
the Adapter Service Editor, Adapter Notification Editor, or Administrative DSPs.name
- the name of the parameterrequired
- true if the parameter should be required; otherwise, false.AdapterException
- if the parameter does not existvoid setShowConnectionName(boolean value)
void setSignatureWrapped(boolean value)
void setValidValues(java.lang.String name, java.lang.String[] values) throws AdapterException
Note that this method does not directly support internationalization. For those applications requiring localized display values, you should use a resource bundle instead.
You can use this method for parameters of type int
or String
.
For integer parameters you must supply two values indicating its minimum and maximum
values. The user interface will employ a GUI widget to display the range of values properly.
For String parameters, you must supply a list of valid values. The user interface will employ a GUI widget to display the set of values properly.
name
- the parameter namevalues
- the list of values. For an int
parameter, the values
array must have two elements: a minimum value and a maximum
value. For a String parameter, the array can have any number
of elements.AdapterException
- if the parameter does not exist
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.