public interface ParameterProvider
Modifier and Type | Method and Description |
---|---|
ParameterDefinition |
getParameterDefinition(java.lang.String parameterName)
Returns the parameter definition for the parameter with the specified name
or
null if no such parameter exists in this provider. |
java.lang.String |
getParameterLabel(java.lang.String parameterName)
Returns the label of the named parameter or
null if no such parameter
exists. |
ParameterStorage |
getParameterStorage(java.lang.String parameterName)
Returns the storage of the named parameter or
null if no such parameter
exists. |
ParameterType |
getParameterType(java.lang.String parameterName)
Returns the type of the named parameter or
null if no such parameter
exists. |
java.lang.Object |
getParameterValue(java.lang.String parameterName)
Returns the value of the named parameter or
null if no such parameter
exists. |
java.util.Iterator |
parameterIterator()
Returns an iterator of parameter names for this object.
|
void |
setParameterLabel(java.lang.String parameterName,
java.lang.String label)
Sets the label of the named parameter.
|
void |
setParameterStorage(java.lang.String parameterName,
ParameterStorage storage)
Sets the storage of the named parameter.
|
void |
setParameterType(java.lang.String parameterName,
ParameterType type)
Sets the type of the named parameter.
|
void |
setParameterValue(java.lang.String parameterName,
java.lang.Object value)
Sets the value of the named parameter.
|
void setParameterLabel(java.lang.String parameterName, java.lang.String label) throws ObjectLockedException
parameterName
- the parameter namelabel
- the parameter labelObjectLockedException
- if the parameter provider is lockedgetParameterLabel(String)
java.lang.String getParameterLabel(java.lang.String parameterName)
null
if no such parameter
exists.parameterName
- the parameter namenull
if no such parameter
existssetParameterLabel(String, String)
void setParameterStorage(java.lang.String parameterName, ParameterStorage storage) throws ObjectLockedException
parameterName
- the parameter namestorage
- the parameter storageObjectLockedException
- if the parameter provider is lockedgetParameterStorage(String)
ParameterStorage getParameterStorage(java.lang.String parameterName)
null
if no such parameter
exists.parameterName
- the parameter namenull
if no such parameter
existssetParameterStorage(String, ParameterStorage)
void setParameterType(java.lang.String parameterName, ParameterType type) throws ObjectLockedException
parameterName
- the parameter nametype
- the parameter typeObjectLockedException
- if the parameter provider is lockedgetParameterType(String)
ParameterType getParameterType(java.lang.String parameterName)
null
if no such parameter
exists.parameterName
- the parameter namenull
if no such parameter
existssetParameterType(String, ParameterType)
void setParameterValue(java.lang.String parameterName, java.lang.Object value) throws ObjectLockedException
parameterName
- the parameter namevalue
- the parameter valueObjectLockedException
- if the parameter provider is lockedgetParameterValue(String)
java.lang.Object getParameterValue(java.lang.String parameterName)
null
if no such parameter
exists.parameterName
- the parameter namenull
if no such parameter
existssetParameterValue(String, Object)
java.util.Iterator parameterIterator()
ParameterDefinition getParameterDefinition(java.lang.String parameterName)
null
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.parameterName
- the parameter nameParameterDefinition
instanceCopyright © 2014 Integral Solutions Ltd. All Rights Reserved.