Package mks.ci.server.engine

Class LocalTriggerManager.ScriptParameterValueBean

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptParameterValueBean​(java.lang.String paramKey, java.lang.String paramDesc, java.lang.String paramValue, java.lang.Boolean isLocked, int lockedId, java.lang.String lockedLevel, int definedInId, java.lang.String definedInLevel, int valueSetInId, java.lang.String valueSetInLevel)  

    • 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 getDisplayLockedLevel()
      Returns a display version of the locked level.
      java.lang.String getDisplayValueSetInLevel()
      Returns a display version of the value set in level.
      java.lang.String getExposedName()
      Get the name of this bean: imParametersBean
      java.lang.Boolean getIsLocked()
      Returns whether or not the parameter value is locked.
      java.lang.String getLockedLevel()
      Gets the level in the parameter resolution hierarchy that this parameter is locked in.
      int getLockedLevelId()
      Returns the item id from which this parameter is locked.
      java.lang.String getParamDesc()
      Returns the description of the parameter value.
      java.lang.String getParamKey()
      Returns the name of the parameter.
      java.lang.String getParamType()
      Returns the value for the parameter.
      java.lang.String getValueSetInLevel()
      Gets the level in the parameter resolution hierarchy that this parameter value is set in.
      int getValueSetInLevelId()
      Returns the item id from which this parameter value is set.

      • 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

      • ScriptParameterValueBean

        public ScriptParameterValueBean​(java.lang.String paramKey,
                                java.lang.String paramDesc,
                                java.lang.String paramValue,
                                java.lang.Boolean isLocked,
                                int lockedId,
                                java.lang.String lockedLevel,
                                int definedInId,
                                java.lang.String definedInLevel,
                                int valueSetInId,
                                java.lang.String valueSetInLevel)

    • Method Detail

      • getExposedName

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

      • getParamKey

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

      • getParamDesc

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

      • getParamType

        public java.lang.String getParamType()
        Returns the value for the parameter.

      • getIsLocked

        public java.lang.Boolean getIsLocked()
        Returns whether or not the parameter value is locked.

      • getLockedLevel

        public java.lang.String getLockedLevel()
        Gets the level in the parameter resolution hierarchy that this parameter is locked in. (i.e. local, project, session, doc, fva).
        See Also:
        getDisplayLockedLevel()

      • getDisplayLockedLevel

        public java.lang.String getDisplayLockedLevel()
        Returns a display version of the locked level.
        See Also:
        getLockedLevel()

      • getLockedLevelId

        public int getLockedLevelId()
        Returns the item id from which this parameter is locked. This corresponds to getLockedLevel() (@see getLockedLevel()), only it is the item id counterpart.

      • 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). This refers to the parameter definition - not where the value is set.
        See Also:
        getValueSetInLevel(), getDisplayDefinedInLevel()

      • getDisplayDefinedInLevel

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

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

      • getValueSetInLevel

        public java.lang.String getValueSetInLevel()
        Gets the level in the parameter resolution hierarchy that this parameter value is set in. (i.e. local, project, session, doc, fva).
        See Also:
        getDisplayValueSetInLevel()

      • getDisplayValueSetInLevel

        public java.lang.String getDisplayValueSetInLevel()
        Returns a display version of the value set in level.
        See Also:
        getValueSetInLevel()

      • getValueSetInLevelId

        public int getValueSetInLevelId()
        Returns the item id from which this parameter value is set. This corresponds to getValueSetInLevel() (@see getValueSetInLevel()), only it is the item id counterpart.