com.google.gdata.data.finance
Class Gain

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by com.google.gdata.data.finance.Gain
All Implemented Interfaces:
Extension

public class Gain
extends ExtensionPoint

Total gain for the portfolio or position.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
 
Constructor Summary
Gain()
          Default mutable constructor.
 
Method Summary
 void addMoney(Money money)
          Adds a new monetary value of the total gain.
 void declareExtensions(ExtensionProfile extProfile)
          Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
          Returns the extension description, specifying whether it is required, and whether it is repeatable.
 java.util.List<Money> getMoney()
          Returns the monetary value of the total gain.
 boolean hasMoney()
          Returns whether it has the monetary value of the total gain.
 java.lang.String toString()
           
 
Methods inherited from class com.google.gdata.data.ExtensionPoint
addExtension, addRepeatingExtension, generateCumulativeXmlBlob, getExtension, getExtensions, getHandler, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit
 
Methods inherited from class com.google.gdata.data.AbstractExtension
disableStrictValidation, enableStrictValidation, generate, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, setImmutable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Gain

public Gain()
Default mutable constructor.

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)
Description copied from class: ExtensionPoint
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Overrides:
declareExtensions in class ExtensionPoint
Parameters:
extProfile - the ExtensionProfile to initialize.

getMoney

public java.util.List<Money> getMoney()
Returns the monetary value of the total gain.

Returns:
monetary value of the total gain

addMoney

public void addMoney(Money money)
Adds a new monetary value of the total gain.

Parameters:
money - monetary value of the total gain

hasMoney

public boolean hasMoney()
Returns whether it has the monetary value of the total gain.

Returns:
whether it has the monetary value of the total gain

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean required,
                                                         boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters:
required - whether it is required
repeatable - whether it is repeatable
Returns:
extension description

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object