ParameterProvider Objects

Identifies objects that contain parameters. Parameters do not control the behaviour of the implementing class directly but provide a look-up mechanism for values that may affect the behaviour of other objects.

p.getParameterDefinition(parameterName) : ParameterDefinition

parameterName (string) : the parameter name

Returns the parameter definition for the parameter with the specified name or None if no such parameter exists in this provider. The result may be a snapshot of the definition at the time the method was called and need not reflect any subsequent modifications made to the parameter through this provider.

p.getParameterLabel(parameterName) : string

parameterName (string) : the parameter name

Returns the label of the named parameter or None if no such parameter exists.

p.getParameterStorage(parameterName) : ParameterStorage

parameterName (string) : the parameter name

Returns the storage of the named parameter or None if no such parameter exists.

p.getParameterType(parameterName) : ParameterType

parameterName (string) : the parameter name

Returns the type of the named parameter or None if no such parameter exists.

p.getParameterValue(parameterName) : Object

parameterName (string) : the parameter name

Returns the value of the named parameter or None if no such parameter exists.

p.parameterIterator() : Iterator

Returns an iterator of parameter names for this object.

p.setParameterLabel(parameterName, label)

parameterName (string) : the parameter name

label (string) : the parameter label

Sets the label of the named parameter.

Exceptions:

ObjectLockedException : if the parameter provider is locked

p.setParameterStorage(parameterName, storage)

parameterName (string) : the parameter name

storage (ParameterStorage) : the parameter storage

Sets the storage of the named parameter.

Exceptions:

ObjectLockedException : if the parameter provider is locked

p.setParameterType(parameterName, type)

parameterName (string) : the parameter name

type (ParameterType) : the parameter type

Sets the type of the named parameter.

Exceptions:

ObjectLockedException : if the parameter provider is locked

p.setParameterValue(parameterName, value)

parameterName (string) : the parameter name

value (Object) : the parameter value

Sets the value of the named parameter.

Exceptions:

ObjectLockedException : if the parameter provider is locked