Package mks.ci.server.engine

Class LocalTriggerManager.ScriptChangePackageAttributeBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    LocalTriggerManager
    public static class LocalTriggerManager.ScriptChangePackageAttributeBean
extends LocalTriggerManager.ScriptIdentifiedBean
implements mks.frame.triggers.ScriptExposableBean
    A bean describing a change package attribute or change package entry attribute. These beans are obtained via the imChangePackageTypeBean. via the .getChangePackageAttrbutes(), .getChangePackageEntryAttributes() and .getChangePackageEntryKeyAttributes() methods.

    • Constructor Detail

      • ScriptChangePackageAttributeBean

        public ScriptChangePackageAttributeBean​(int userId,
                                        mks.ci.server.engine.CPAttribute cpAttrib,
                                        java.sql.Connection c)

    • Method Detail

      • getName

        public java.lang.String getName()
        Retrieve the real name of this change package attribute.
        Returns:
        The real name of this change package attribute.

      • getDisplayName

        public java.lang.String getDisplayName()
        Retrieve the display name of this change package attribute.
        Returns:
        The display name of this change package attribute.

      • getDataType

        public java.lang.String getDataType()
        Returns the data type of this attribute.
        Returns:
        A String representing the data type, either: logical, date, float, cpid, cpidlist, integer, string, user, stringlist or type.

      • isReadOnly

        public boolean isReadOnly()
        Returns whether or not the value of this attribute is read-only.
        Returns:
        True if the value of this attribute is read-only, false otherwise.

      • isMandatory

        public boolean isMandatory()
        Returns whether or not a value for this attribute is mandatory.
        Returns:
        True if a value for this attribute is mandatory, false otherwise.

      • getDisplayFormat

        public java.lang.String getDisplayFormat()
        Returns the display format for this attribute.
        Returns:
        The display format of this attribute, for logical attributes the returned value will be either: truefalse, tf, yesno, or yn. For all other attribute types the value `unknown' will be returned.

      • getStringListValues

        public java.lang.String[] getStringListValues()
        For attributes of type `stringlist' this method will return all the valid string values for the attribute.
        Returns:
        An array of Strings representing all the string values that this string list attribute is allowed to take, otherwise null.

      • getDecimalPlaces

        public int getDecimalPlaces()
        For attributes of type `float' this method will return the maximum number of digits allowed in the fraction portion of an attribute value.
        Returns:
        The maximum number of digits allowed in the fraction portion of an attribute value, otherwise 0.

      • getExposedName

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