public class BaseMetadata extends java.lang.Object implements WmDescriptor, WmUIDescriptor
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
_description |
protected java.lang.String |
_displayName |
protected com.wm.data.IData |
_features |
protected java.lang.String |
_name |
protected AdapterParameters |
_parameters |
protected AdapterResourceBundleManager |
_resourceBundleManager |
protected java.lang.String |
_templateURL |
Constructor and Description |
---|
BaseMetadata() |
Modifier and Type | Method and Description |
---|---|
void |
createGroup(java.lang.String groupName,
java.lang.String[] members)
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.
|
com.wm.data.IData |
getFeatures() |
java.lang.String |
getFeatureValue(java.lang.String featureName) |
java.lang.String |
getName()
Returns the system name of the connection, listener, service, or notification.
|
AdapterFeatureDescriptor |
getParameterDescriptor(java.lang.String name) |
AdapterParameters |
getParameters() |
java.lang.String |
getTemplateURL() |
boolean |
isPassFullPipeline() |
boolean |
isShowConnectionName() |
boolean |
isSignatureWrapped() |
void |
setClassName(java.lang.String className) |
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)
Start implement AdapterDescriptor ******
|
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 |
setResourceDomainLookup(java.lang.String lookupKey)
Sets the ResourceDomain for lookup key.
|
void |
setResourceDomainLookup(java.lang.String lookupKey,
java.lang.String[] dependents)
Sets the ResourceDomain lookup key and its dependents.
|
void |
setResourceDomainLookup(java.lang.String lookupKey,
java.lang.String[] dependents,
boolean exploreButton) |
void |
setShowConnectionName(boolean value) |
void |
setSignatureWrapped(boolean value) |
void |
setTemplateURL(java.lang.String name) |
void |
setValidValues(java.lang.String name,
java.lang.String[] values)
Sets the list of valid values that a parameter may have.
|
protected java.lang.String _description
protected java.lang.String _displayName
protected com.wm.data.IData _features
protected java.lang.String _name
protected AdapterParameters _parameters
protected AdapterResourceBundleManager _resourceBundleManager
protected java.lang.String _templateURL
public void createGroup(java.lang.String groupName, java.lang.String[] members) throws AdapterException
WmDescriptor
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.
createGroup
in interface WmDescriptor
groupName
- the name of the display group to createmembers
- an ordered list of members in this groupAdapterException
- if any of the group's members does not existpublic java.lang.String getDescription()
WmDescriptor
getDescription
in interface WmDescriptor
WmDescriptor.setDescription(java.lang.String)
,
WmDescriptor.setDescriptions(com.wm.adk.i18n.AdapterResourceBundleManager, java.util.Locale)
public java.lang.String getDisplayName()
WmDescriptor
WmDescriptor.getName()
.getDisplayName
in interface WmDescriptor
public com.wm.data.IData getFeatures()
public java.lang.String getFeatureValue(java.lang.String featureName)
getFeatureValue
in interface WmDescriptor
public java.lang.String getName()
WmDescriptor
getName
in interface WmDescriptor
WmDescriptor.setName(String)
public AdapterFeatureDescriptor getParameterDescriptor(java.lang.String name) throws AdapterException
AdapterException
public AdapterParameters getParameters()
public java.lang.String getTemplateURL()
public boolean isPassFullPipeline()
isPassFullPipeline
in interface WmDescriptor
public boolean isShowConnectionName()
isShowConnectionName
in interface WmDescriptor
public boolean isSignatureWrapped()
isSignatureWrapped
in interface WmDescriptor
public void setClassName(java.lang.String className)
public void setDescription(java.lang.String description)
WmDescriptor
setDescription
in interface WmDescriptor
description
- the description for the connection, listener, service, or notificationpublic void setDescription(java.lang.String name, java.lang.String description) throws AdapterException
WmDescriptor
WmDescriptor.setDescriptions(AdapterResourceBundleManager, Locale)
).setDescription
in interface WmDescriptor
name
- the name of the parameterdescription
- the parameter's descriptionAdapterException
- if the parameter does not existWmDescriptor.setDescriptions(AdapterResourceBundleManager, Locale)
public void setDescriptions(AdapterResourceBundleManager ar, java.util.Locale locale) throws AdapterException
setDescriptions
in interface WmDescriptor
ar
- the adapter's resource bundle managerlocale
- the client localeAdapterException
- if the metadata or resource bundle setting is not correctpublic void setDisplayName(java.lang.String displayName)
WmDescriptor
setDisplayName
in interface WmDescriptor
displayName
- the display name of the connection, listener, service, or notificationpublic void setDisplayName(java.lang.String name, java.lang.String display) throws AdapterException
WmDescriptor
setDisplayName
in interface WmDescriptor
name
- the name of the parameterAdapterException
- if the parameter does not existpublic void setFeatureValue(java.lang.String featureName, java.lang.String featureValue)
setFeatureValue
in interface WmDescriptor
public void setGroupName(java.lang.String name, java.lang.String groupName) throws AdapterException
WmDescriptor
groupName
was previously created by a call to
WmDescriptor.createGroup(String, String[])
, the new parameter is appended to those
already declared in that group.setGroupName
in interface WmDescriptor
name
- the name of the parametergroupName
- the name of the display groupAdapterException
- if the parameter does not existWmDescriptor.createGroup(String, String[])
public void setHidden(java.lang.String name) throws AdapterException
WmDescriptor
setHidden
in interface WmDescriptor
name
- the name of the parameter.AdapterException
- if the parameter does not existpublic void setHidden(java.lang.String name, boolean hidden) throws AdapterException
WmDescriptor
hidden
is set to true
.
Hidden parameters do not appear in tools such as the Adapter Service Editor, Adapter
Notification Editor, or Administrative DSPs.setHidden
in interface WmDescriptor
name
- the name of the parameter.hidden
- whether or not the property is hiddenAdapterException
- if the parameter does not existpublic void setMaxSeqLength(java.lang.String name, int length) throws AdapterException
WmDescriptor
setMaxSeqLength
in interface WmDescriptor
name
- the name of the sequence parameterlength
- maximum number of the elements in the sequence parameterAdapterException
- if the parameter does not existpublic void setMaxStringLength(java.lang.String name, int length) throws AdapterException
WmDescriptor
setMaxStringLength
in interface WmDescriptor
name
- the name of the parameterlength
- the maximum string length for a parameter's valueAdapterException
- if the parameter does not existpublic void setMinSeqLength(java.lang.String name, int length) throws AdapterException
WmDescriptor
setMinSeqLength
in interface WmDescriptor
name
- the name of the sequence parameterlength
- the minimum number of elements in the sequenceAdapterException
- if the parameter does not existpublic void setMinSeqLength(java.lang.String name, int seqLength, int stringLength) throws AdapterException
WmDescriptor
void setMinSeqLength("resourceTables",1,1);
setMinSeqLength
in interface WmDescriptor
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 existpublic void setMinStringLength(java.lang.String name, int length) throws AdapterException
WmDescriptor
setMinStringLength
in interface WmDescriptor
name
- the name of the parameterlength
- the minimum string length for the parameter's valueAdapterException
- if the parameter does not existpublic void setName(java.lang.String name)
WmDescriptor
setName
in interface WmDescriptor
name
- the new system namepublic void setPassFullPipeline(boolean value)
setPassFullPipeline
in interface WmDescriptor
public void setPassword(java.lang.String name) throws AdapterException
WmDescriptor
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.setPassword
in interface WmDescriptor
name
- the name of the parameterAdapterException
- if the parameter does not existpublic void setPassword(java.lang.String name, boolean password) throws AdapterException
WmDescriptor
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.setPassword
in interface WmDescriptor
name
- the name of the parameterpassword
- true if name
should be treated as
a password parameter; otherwise, false.AdapterException
- if the parameter does not existpublic void setRequired(java.lang.String name) throws AdapterException
WmDescriptor
setRequired
in interface WmDescriptor
name
- the name of the parameterAdapterException
- if the parameter does not existpublic void setRequired(java.lang.String name, boolean required) throws AdapterException
WmDescriptor
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.setRequired
in interface WmDescriptor
name
- the name of the parameterrequired
- true if the parameter should be required; otherwise, false.AdapterException
- if the parameter does not existpublic void setResourceDomainLookup(java.lang.String lookupKey) throws AdapterException
WmUIDescriptor
setResourceDomainLookup
in interface WmUIDescriptor
lookupKey
- systemName of the field.AdapterException
- if one or more of the values is not a parameterpublic void setResourceDomainLookup(java.lang.String lookupKey, java.lang.String[] dependents) throws AdapterException
WmUIDescriptor
setResourceDomainLookup
in interface WmUIDescriptor
lookupKey
- systemName of the field.dependents
- the list of dependents, which must be the system names of fields.AdapterException
- if one or more of the values is not a parameterpublic void setResourceDomainLookup(java.lang.String lookupKey, java.lang.String[] dependents, boolean exploreButton) throws AdapterException
AdapterException
public void setShowConnectionName(boolean value)
setShowConnectionName
in interface WmDescriptor
public void setSignatureWrapped(boolean value)
setSignatureWrapped
in interface WmDescriptor
public void setTemplateURL(java.lang.String name)
public void setValidValues(java.lang.String name, java.lang.String[] values) throws AdapterException
WmDescriptor
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.
setValidValues
in interface WmDescriptor
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.