Package nis.svc.opt.api

Interface ProjectSettings.IndustrySectorAttributesSettings

  • Enclosing interface:
    ProjectSettings
    public static interface ProjectSettings.IndustrySectorAttributesSettings

    • Method Detail

      • industryMinimumConstraintType

        Types.ConstraintType industryMinimumConstraintType()
        returns the industry minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        industry min constraint type.

      • industryMinimumConstraintType

        void industryMinimumConstraintType​(Types.ConstraintType type)
        sets the industry minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - industry min constraint type.

      • industryMaximumConstraintType

        Types.ConstraintType industryMaximumConstraintType()
        returns the industry maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        industry max constraint type.

      • industryMaximumConstraintType

        void industryMaximumConstraintType​(Types.ConstraintType type)
        sets the industry maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - industry max constraint type.

      • sectorMinimumConstraintType

        Types.ConstraintType sectorMinimumConstraintType()
        returns the sector minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        sector min constraint type.

      • sectorMinimumConstraintType

        void sectorMinimumConstraintType​(Types.ConstraintType type)
        sets the sector minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - sector min constraint type.

      • sectorMaximumConstraintType

        Types.ConstraintType sectorMaximumConstraintType()
        returns the sector maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        sector max constraint type.

      • sectorMaximumConstraintType

        void sectorMaximumConstraintType​(Types.ConstraintType type)
        sets the sector maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - sector max constraint type.

      • attributeMinimumConstraintType

        Types.ConstraintType attributeMinimumConstraintType()
        returns the attribute minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        attribute min constraint type.

      • attributeMinimumConstraintType

        void attributeMinimumConstraintType​(Types.ConstraintType type)
        sets the attribute minimum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - attribute min constraint type.

      • attributeMaximumConstraintType

        Types.ConstraintType attributeMaximumConstraintType()
        returns the attribute maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Returns:
        attribute max constraint type.

      • attributeMaximumConstraintType

        void attributeMaximumConstraintType​(Types.ConstraintType type)
        sets the attribute maximum constraint type. valid values are "absolute", "relative to initial" and "relative to benchmark"
        Parameters:
        type - attribute max constraint type.

      • mapping

        SettingsTables.MappingRow[] mapping()
        returns an array of industry / industry group mapping pairs
        Returns:
        industry / industry group mappings...

      • mappingClear

        void mappingClear()

      • addMapping

        void addMapping​(java.lang.String id,
                java.lang.String name)
        map an industry to an industry group. the id parameter corresponds to the industry value in the risk model. the name parameter corresponds to the industry group name.
        Parameters:
        id - industry id
        name - industry group name

      • industries

        SettingsTables.IndustryRow[] industries()
        returns an array of industry group objects. these objects consist of a group id, name, penalty value, minimum constraint weight, maximum constraint weight and a sectorId. the sector id can be a dummy value if no sectors (groups of industry groups) are specified
        Returns:
        industry groups

      • industriesClear

        void industriesClear()

      • addIndustry

        void addIndustry​(java.lang.String id,
                 java.lang.String name,
                 double penalty,
                 double minimumWeight,
                 double maximumWeight,
                 java.lang.String sectorId)
        adds an industry group. parameters are: group id, name, penalty value, minimum constraint weight, maximum constraint weight and a sectorId. the sector id can be a dummy value if no sectors (groups of industry groups) are specified
        Parameters:
        id - group id
        name - group name
        penalty - group penalty val
        minimumWeight - group min val. units are percent.
        maximumWeight - group max val. units are percent.
        sectorId - group sector id.

      • sectors

        SettingsTables.SectorRow[] sectors()
        returns an array of sector objects. these objects consist of a sector id, name, penalty value, minimum constraint weight and maximum constraint weight.
        Returns:
        sectors.

      • sectorsClear

        void sectorsClear()

      • addSector

        void addSector​(java.lang.String id,
               java.lang.String name,
               double penalty,
               double minimumWeight,
               double maximumWeight)
        adds a sector (group of industry groups). parameters are: sector id, name, penalty value, minimum constraint weight and maximum constraint weight.
        Parameters:
        id - sector id.
        name - sector name.
        penalty - sector penalty.
        minimumWeight - sector min weight. units are percent.
        maximumWeight - sector max weight. units are percent.

      • attributes

        SettingsTables.AttributeRow[] attributes()
        returns an array of attribute objects. objects contain the attribute name, goal, scale, minweight and maxweight.
        Returns:
        attribute objects added.

      • attributesClear

        void attributesClear()

      • addAttribute

        SettingsTables.AttributeRow addAttribute​(java.lang.String name,
                                         double goal,
                                         double scale,
                                         double minimumWeight,
                                         double maximumWeight)
        adds an attribute. parameters are attribute name, goal, scale, minweight and maxweight. returns the attribute object. each object MUST be accessed afterwards to add attribute asset id / value pairs.
        Parameters:
        name - attribute name
        goal - attribute goal value
        scale - attribute penalty scale
        minimumWeight - attribute min weight constraint. units are percent.
        maximumWeight - attribute max weight constraint. units are percent.
        Returns:
        the attribute row. make sure to add assetID / attribute value pairs to each row or you WILL crash.