Package mks.ci.server.engine

Class LocalTriggerManager.ScriptParameterBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    LocalTriggerManager
    public static class LocalTriggerManager.ScriptParameterBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean
    Bean which describes an individual parameter.

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptParameterBean​(java.lang.String paramKey, java.lang.String paramDesc, java.lang.String paramType, java.lang.String[] values, int definedInId, java.lang.String definedInLevel)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefinedInLevel()
      Gets the level in the parameter resolution hierarchy that this parameter is defined in.
      int getDefinedInLevelId()
      Returns the item id from which this parameter is defined.
      java.lang.String getDisplayDefinedInLevel()
      Returns a display version of the defined in level.
      java.lang.String getExposedName()
      Get the name of this bean: imParameterBean
      java.lang.String getParamDesc()
      Returns the description of the parameter.
      java.lang.String getParamKey()
      Returns the name of the parameter.
      java.lang.String getParamType()
      Returns the type of the parameter.
      java.lang.String[] getValues()
      Returns the values of the parameter, if any.

      • 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

      • ScriptParameterBean

        public ScriptParameterBean​(java.lang.String paramKey,
                           java.lang.String paramDesc,
                           java.lang.String paramType,
                           java.lang.String[] values,
                           int definedInId,
                           java.lang.String definedInLevel)

    • Method Detail

      • getExposedName

        public java.lang.String getExposedName()
        Get the name of this bean: imParameterBean
        Specified by:
        getExposedName in interface mks.frame.triggers.ScriptExposableBean
        Specified by:
        getExposedName in class ScriptBaseBean
        Returns:
        the bean name: imParameterBean.

      • getParamKey

        public java.lang.String getParamKey()
        Returns the name of the parameter.

      • getParamDesc

        public java.lang.String getParamDesc()
        Returns the description of the parameter.

      • getParamType

        public java.lang.String getParamType()
        Returns the type of the parameter.

      • getValues

        public java.lang.String[] getValues()
        Returns the values of the parameter, if any. May return null.

      • getDefinedInLevel

        public java.lang.String getDefinedInLevel()
        Gets the level in the parameter resolution hierarchy that this parameter is defined in. (i.e. local, project, session, doc, fva). Also, @see getDisplayDefinedInLevel()

      • getDisplayDefinedInLevel

        public java.lang.String getDisplayDefinedInLevel()
        Returns a display version of the defined in level.

      • getDefinedInLevelId

        public int getDefinedInLevelId()
        Returns the item id from which this parameter is defined. This corresponds to getDefinedInLevel() (@see getDefinedInLevel()), only it is the item id counterpart.