Package mks.ci.server.engine

Class LocalTriggerManager.ScriptCustomFieldValueBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    LocalTriggerManager
    public static class LocalTriggerManager.ScriptCustomFieldValueBean
extends ScriptBaseBean
    A bean representing a single custom field value on an issue. A custom field value bean is obtained from the issue bean, via the getCustomFieldValueBean method. A list of custom field value beans can be obtained from the issue bean, via the getCustomFieldValueBeans method.

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptCustomFieldValueBean​(mks.ci.server.engine.CustomFieldValue cfv)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExposedName()
      Returns the name of this bean that is exposed to the scripting language.
      java.lang.String getName()
      Returns Name of Custom Field Value
      java.lang.Object getValue()
      Retrieve the value of the custom field.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ScriptCustomFieldValueBean

        public ScriptCustomFieldValueBean​(mks.ci.server.engine.CustomFieldValue cfv)

    • Method Detail

      • getExposedName

        public java.lang.String getExposedName()
        Returns the name of this bean that is exposed to the scripting language.
        Specified by:
        getExposedName in interface mks.frame.triggers.ScriptExposableBean
        Specified by:
        getExposedName in class ScriptBaseBean
        Returns:
        the bean name: imCustomFieldValueBean.

      • getName

        public java.lang.String getName()
        Returns Name of Custom Field Value
        Returns:
        Custom Field Value name

      • getValue

        public java.lang.Object getValue()
                          throws mks.frame.triggers.TriggerException
        Retrieve the value of the custom field. The actual value returned is always a java object:
        • Integer: Java 'Integer' object
        • Boolean: Java 'Boolean' object
        • Double: Java 'Double' object
        • PickList: Java Set<String> object. Each set value is the String name of a picked entry. You may receive a set of the single value as the pick is single valued.
        • Date: Java 'Date' object
        • Text: Java 'String' object.
            Note that in javascript, you can mostly use all these values without converting, javascript will for example extract the int value out of the Integer if you try to use it for arithmetic.
        Returns:
        Various, if the field has not been set, the null value.
        Throws:
        mks.frame.triggers.TriggerException