Package mks.ci.server.engine

Class LocalTriggerManager.ScriptParametersFieldBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptParametersFieldBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

LocalTriggerManager

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

Bean which describes the parameters field. The individual parameters can be retrieved as an array of ScriptParameterBean objects.

Constructor Summary

Constructors

Constructor	Description
ScriptParametersFieldBean(mks.ci.common.ParametersConfig parameters, mks.ci.common.ParameterResolverBase resolver)

Method Summary

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

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

ScriptParametersFieldBean

public ScriptParametersFieldBean(mks.ci.common.ParametersConfig parameters,
                                 mks.ci.common.ParameterResolverBase resolver)

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 keys.

Throws:

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

getParameterBeans

public LocalTriggerManager.ScriptParameterBean[] getParameterBeans()
                                                            throws mks.frame.triggers.TriggerException

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

Returns:

an array of ScriptParameterBean 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: imParametersFieldBean

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: imParametersFieldBean.