Package de.mid.innovator.m2msdk.model.parameter

Class ParameterTemplate

java.lang.Object

de.mid.innovator.m2msdk.model.parameter.ParameterTemplate

All Implemented Interfaces:

ParameterTemplateIF, Serializable

Direct Known Subclasses:

ParameterTemplateBoolean, ParameterTemplateEnum, ParameterTemplateExpression, ParameterTemplateItem, ParameterTemplateOption, ParameterTemplateStepReference

public class ParameterTemplate
extends Object
implements Serializable, ParameterTemplateIF

Parameter Template Descriptor.

Version:

10.1.1

Author:

nagl

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterTemplate(String name)
ParameterTemplate(String name, String defaultValue)	Create a template with name and default value.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Get the default value of the parameter template.
String	getDescription()	Get a description of parameter.
ParameterTemplates	getKnownParameters(MappingElementIF me, ConfigurationItemIF iItem)
String	getName()
ParameterProposalList	getValidProposals()	Get list of valid proposals.
boolean	isValidValue(String fExpression)	Check if the expression is a valid value.
void	setConfigurationContext(SessionInterface iSession, MetaModel sourceMM, MetaModel targetMM, ConfigurationItemIF context)
void	setValidProposals(ParameterProposalList iListProposal)	Set list of valid proposals.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ParameterTemplate

public ParameterTemplate(String name)

ParameterTemplate

public ParameterTemplate(String name,
 String defaultValue)

Create a template with name and default value.

Parameters:

name - parameter name

defaultValue - default value, if parameter is not set

Method Details

setValidProposals

public void setValidProposals(ParameterProposalList iListProposal)

Set list of valid proposals.

Parameters:

iListProposal - List of valid values and descriptions

getName

public String getName()

Specified by:

getName in interface ParameterTemplateIF

getDefaultValue

public String getDefaultValue()

Get the default value of the parameter template. This value is used as value for the new parameter.

Returns:

default value

getValidProposals

public ParameterProposalList getValidProposals()

Get list of valid proposals.

Specified by:

getValidProposals in interface ParameterTemplateIF

Returns:

list of proposals.

getDescription

public String getDescription()

Get a description of parameter.

Specified by:

getDescription in interface ParameterTemplateIF

Returns:

long description of what the parameter affects and what are the possible values.

isValidValue

public boolean isValidValue(String fExpression)

Check if the expression is a valid value.

Parameters:

fExpression - expression to check

Returns:

true, if the expression is a valid value

toString

public String toString()

Overrides:

toString in class Object

getKnownParameters

public ParameterTemplates getKnownParameters(MappingElementIF me,
 ConfigurationItemIF iItem)
                                      throws M2MException,
RemoteException

Specified by:

getKnownParameters in interface ParameterTemplateIF

Throws:

M2MException

RemoteException

setConfigurationContext

public void setConfigurationContext(SessionInterface iSession,
 MetaModel sourceMM,
 MetaModel targetMM,
 ConfigurationItemIF context)
                             throws RemoteException,
M2MException

Specified by:

setConfigurationContext in interface ParameterTemplateIF

Throws:

RemoteException

M2MException