ObjectiveTermUnit

java.lang.Object

org.drip.portfolioconstruction.optimizer.ObjectiveTermUnit

public class ObjectiveTermUnit
extends java.lang.Object

ObjectiveTermUnit holds the Details of a Single Objective Term that forms the Strategy.

Module = Portfolio Core Module
Library = Asset Allocation Analytics
Project = Portfolio Construction under Allocation Constraints
Package = Core Portfolio Construction Optimizer Suite

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

ObjectiveTermUnit(ObjectiveTerm objectiveTerm, double weight)
ObjectiveTermUnit Constructor

Method Summary

Modifier and Type	Method	Description
`boolean`	`activate()`	Turn ON the Objective Term Unit
`boolean`	`deactivate()`	Turn OFF the Objective Term Unit
`boolean`	`isActive()`	Indicate if the Objective Term is Active
`ObjectiveTerm`	`objectiveTerm()`	Retrieve the Objective Term
`double`	`weight()`	Weight of the Objective Term

Methods inherited from class java.lang.Object

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

Constructor Details
- ObjectiveTermUnit
  
  public ObjectiveTermUnit(ObjectiveTerm objectiveTerm, double weight) throws java.lang.Exception
  
  ObjectiveTermUnit Constructor
  
  Parameters:
  
  objectiveTerm - The Objective Term
  
  weight - The Objective Term Weight
  
  Throws:
  
  java.lang.Exception - Thrown if the Inputs are Invalid
Method Details
- isActive
  
  public boolean isActive()
  
  Indicate if the Objective Term is Active
  
  Returns:
  
  TRUE - The Objective Term is Active
- activate
  
  public boolean activate()
  
  Turn ON the Objective Term Unit
  
  Returns:
  
  The Objective Term Unit is ON
- deactivate
  
  public boolean deactivate()
  
  Turn OFF the Objective Term Unit
  
  Returns:
  
  The Objective Term Unit is OFF
- weight
  
  public double weight()
  
  Weight of the Objective Term
  
  Returns:
  
  Weight of the Objective Term
- objectiveTerm
  
  public ObjectiveTerm objectiveTerm()
  
  Retrieve the Objective Term
  
  Returns:
  
  TRUE - The Objective Term