Class LocalTriggerManager.ScriptChangePackageTypeBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    LocalTriggerManager

    public static class LocalTriggerManager.ScriptChangePackageTypeBean
    extends LocalTriggerManager.ScriptIdentifiedBean
    implements mks.frame.triggers.ScriptExposableBean
    A bean describing a change package type. These beans are obtained via the imServerBean. via the .getChangePackageTypes() and .getChangePackageType(String) methods. For example,
     bsf.lookupBean("imServerBean").getChangePackageTypesBean("si");
     
    • Constructor Detail

      • ScriptChangePackageTypeBean

        public ScriptChangePackageTypeBean​(int userId,
                                           mks.ci.server.engine.CPType cpType,
                                           java.sql.Connection c)
    • Method Detail

      • getName

        public java.lang.String getName()
                                 throws mks.frame.triggers.TriggerException
        Return the real name of this change package type.
        Returns:
        The real name of this change package type.
        Throws:
        mks.frame.triggers.TriggerException - On error when fetching the value.
      • getDisplayName

        public java.lang.String getDisplayName()
                                        throws mks.frame.triggers.TriggerException
        Return the display name of this change package type.
        Returns:
        The display name of this change package type.
        Throws:
        mks.frame.triggers.TriggerException - On error when fetching the value.
      • getChangePackageAttributes

        public LocalTriggerManager.ScriptChangePackageAttributeBean[] getChangePackageAttributes()
                                                                                          throws mks.frame.triggers.TriggerException
        Return an array of all the change package attributes for this change package type.
        Returns:
        An array of all the change package attributes for this change package type.
        Throws:
        mks.frame.triggers.TriggerException - On error when fetching the values.
      • getChangePackageEntryAttributes

        public LocalTriggerManager.ScriptChangePackageAttributeBean[] getChangePackageEntryAttributes()
                                                                                               throws mks.frame.triggers.TriggerException
        Return an array of all the change package entry attributes for this change package type.
        Returns:
        An array of all the change package entry attributes for this change package type.
        Throws:
        mks.frame.triggers.TriggerException - On error when fetching the values.
      • getChangePackageEntryKeyAttributes

        public LocalTriggerManager.ScriptChangePackageAttributeBean[] getChangePackageEntryKeyAttributes()
                                                                                                  throws mks.frame.triggers.TriggerException
        Return an array of the change package entry attributes that make up the entry key for this change package type.
        Returns:
        An array of the change package entry attributes that make up the entry key for this change packge type.
        Throws:
        mks.frame.triggers.TriggerException - On error when fetching the values.
      • getChangePackageAttributeBean

        public LocalTriggerManager.ScriptChangePackageAttributeBean getChangePackageAttributeBean​(java.lang.String cpAttribute)
                                                                                           throws mks.frame.triggers.TriggerException
        Retreive the imChangePackageAttributeBean for the named change package attribute.
        Parameters:
        cpAttribute - The real name of the change package attribute.
        Returns:
        The appropriate change package attribute bean.
        Throws:
        mks.frame.triggers.TriggerException - If the named change package attribute does not exist for this type.
      • getChangePackageEntryAttributeBean

        public LocalTriggerManager.ScriptChangePackageAttributeBean getChangePackageEntryAttributeBean​(java.lang.String cpEntryAttribute)
                                                                                                throws mks.frame.triggers.TriggerException
        Retreive the imChangePackageAttributeBean for the named change package entry attribute.
        Parameters:
        cpEntryAttribute - The real name of the change package entry attribute.
        Returns:
        The appropriate change package attribute bean.
        Throws:
        mks.frame.triggers.TriggerException - If the named change package entry attribute does not exist for this type.
      • getExposedName

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