Package mks.ci.server.engine

Class LocalTriggerManager.ScriptParameterValuesBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptParameterValuesBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

LocalTriggerManager

public static class LocalTriggerManager.ScriptParameterValuesBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean

Bean which describes the parameter values field. The individual parameter values can be retrieved as an array of ScriptParameterValueBean objects.

Constructor Summary

Constructors

Constructor	Description
ScriptParameterValuesBean(mks.ci.common.ParametersConfig parameters, mks.ci.common.ParameterResolverBase paramResolver)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExposedName()	Get the name of this bean: imParameterValuesBean
java.lang.String[]	getParameterNames()	Retrieves the names of the parameters in the field.
LocalTriggerManager.ScriptParameterValueBean[]	getParameterValueBeans()	Get the parameters as an array of ScriptParameterValueBean objects.

Methods inherited from class mks.frame.triggers.beans.ScriptBaseBean

getEnvironmentBean, setEnvironmentBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface mks.frame.triggers.ScriptExposableBean

getEnvironmentBean, setEnvironmentBean

Constructor Detail

ScriptParameterValuesBean

public ScriptParameterValuesBean(mks.ci.common.ParametersConfig parameters,
                                 mks.ci.common.ParameterResolverBase paramResolver)

Method Detail

getParameterNames

public java.lang.String[] getParameterNames()
                                     throws mks.frame.triggers.TriggerException

Retrieves the names of the parameters in the field.

Returns:

an array of parameter names.

Throws:

mks.frame.triggers.TriggerException - if there is an error retrieving the parameter information.

getParameterValueBeans

public LocalTriggerManager.ScriptParameterValueBean[] getParameterValueBeans()
                                                                      throws mks.frame.triggers.TriggerException

Get the parameters as an array of ScriptParameterValueBean objects. These objects can be used to retrieve each parameter's name, value, description and whether or not the parameter is locked.

Returns:

an array of ScriptParameterValueBean objects.

Throws:

mks.frame.triggers.TriggerException - if there is an error retrieving the parameter information.

getExposedName

public java.lang.String getExposedName()

Get the name of this bean: imParameterValuesBean

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: imParameterValuesBean.