Package com.onenetwork.platform.common

Class CurrencyConversionFactor

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.CurrencyConversionFactor
All Implemented Interfaces:
Model, java.io.Serializable
public class CurrencyConversionFactor
extends com.onenetwork.platform.common.Model
implements java.io.Serializable
This model is used when the API of a CurrencyConverter is "Data". Overlapping conversion effectivity dates are not allowed for the same from/to currency combination. Gaps are OK, but will result in a runtime exception in the event the gap is hit during conversion. One must explicitly create factors in both directions for a currency pair - the framework will not automatically invert the factor for a reverse conversion.

Java class for CurrencyConversionFactor complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CurrencyConversionFactor">
   <complexContent>
     <extension base="{http://www.onenetwork.com/Platform}Model">
       <sequence>
         <element name="ActionExecTime" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ActionName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InputRefId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Error" type="{http://www.onenetwork.com/Platform}Error" minOccurs="0"/>
         <element name="CreationUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LastModifiedUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LastModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LevelModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ValueChainId" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="CurrencyConverterName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="CurrencyConverterOrganizationName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="CurrencyConverterOrganizationEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="FromCurrency" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="ToCurrency" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="EffectiveStartInclusive" type="{http://www.onenetwork.com/Platform}DateTime"/>
         <element name="EffectiveEndExclusive" type="{http://www.onenetwork.com/Platform}DateTime"/>
         <element name="Factor" type="{http://www.onenetwork.com/Platform}NullableFloat" minOccurs="0"/>
         <element name="Udfs" type="{http://www.onenetwork.com/Platform}NameValuePairList" minOccurs="0"/>
         <element ref="{http://www.onenetwork.com/Platform}MDFs" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Attribute" type="{http://www.onenetwork.com/Platform}AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:
Serialized Form

  • Field Details

  • Constructor Details

  • Method Details

    • getActionExecTime

      public java.util.Calendar getActionExecTime()
      Gets the value of the actionExecTime property.
      Returns:
      possible object is String

    • setActionExecTime

      public void setActionExecTime​(java.util.Calendar value)
      Sets the value of the actionExecTime property.
      Parameters:
      value - allowed object is String

    • isSetActionExecTime

      public boolean isSetActionExecTime()

    • getActionName

      public java.lang.String getActionName()
      Gets the value of the actionName property.
      Overrides:
      getActionName in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setActionName

      public void setActionName​(java.lang.String value)
      Sets the value of the actionName property.
      Overrides:
      setActionName in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetActionName

      public boolean isSetActionName()

    • getInputRefId

      public java.lang.String getInputRefId()
      Gets the value of the inputRefId property.
      Returns:
      possible object is String

    • setInputRefId

      public void setInputRefId​(java.lang.String value)
      Sets the value of the inputRefId property.
      Parameters:
      value - allowed object is String

    • isSetInputRefId

      public boolean isSetInputRefId()

    • getError

      public StatusMessage getError()
      Gets the value of the error property.
      Specified by:
      getError in interface Model
      Overrides:
      getError in class com.onenetwork.platform.common.Model
      Returns:
      possible object is ErrorDef

    • setError

      public void setError​(StatusMessage value)
      Sets the value of the error property.
      Specified by:
      setError in interface Model
      Overrides:
      setError in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is ErrorDef

    • isSetError

      public boolean isSetError()

    • getCreationUser

      public java.lang.String getCreationUser()
      Gets the value of the creationUser property.
      Returns:
      possible object is String

    • setCreationUser

      public void setCreationUser​(java.lang.String value)
      Sets the value of the creationUser property.
      Parameters:
      value - allowed object is String

    • isSetCreationUser

      public boolean isSetCreationUser()

    • getCreationDate

      public java.util.Calendar getCreationDate()
      Gets the value of the creationDate property.
      Returns:
      possible object is String

    • setCreationDate

      public void setCreationDate​(java.util.Calendar value)
      Sets the value of the creationDate property.
      Parameters:
      value - allowed object is String

    • isSetCreationDate

      public boolean isSetCreationDate()

    • getLastModifiedUser

      public java.lang.String getLastModifiedUser()
      Gets the value of the lastModifiedUser property.
      Specified by:
      getLastModifiedUser in interface Model
      Overrides:
      getLastModifiedUser in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedUser

      public void setLastModifiedUser​(java.lang.String value)
      Sets the value of the lastModifiedUser property.
      Specified by:
      setLastModifiedUser in interface Model
      Overrides:
      setLastModifiedUser in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedUser

      public boolean isSetLastModifiedUser()

    • getLastModifiedDate

      public java.util.Calendar getLastModifiedDate()
      Gets the value of the lastModifiedDate property.
      Specified by:
      getLastModifiedDate in interface Model
      Overrides:
      getLastModifiedDate in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedDate

      public void setLastModifiedDate​(java.util.Calendar value)
      Sets the value of the lastModifiedDate property.
      Specified by:
      setLastModifiedDate in interface Model
      Overrides:
      setLastModifiedDate in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedDate

      public boolean isSetLastModifiedDate()

    • getLevelModifiedDate

      public java.util.Calendar getLevelModifiedDate()
      Gets the value of the levelModifiedDate property.
      Returns:
      possible object is String

    • setLevelModifiedDate

      public void setLevelModifiedDate​(java.util.Calendar value)
      Sets the value of the levelModifiedDate property.
      Parameters:
      value - allowed object is String

    • isSetLevelModifiedDate

      public boolean isSetLevelModifiedDate()

    • getValueChainId

      public long getValueChainId()
      Gets the value of the valueChainId property.

    • setValueChainId

      public void setValueChainId​(long value)
      Sets the value of the valueChainId property.

    • isSetValueChainId

      public boolean isSetValueChainId()

    • getCurrencyConverterName

      public java.lang.String getCurrencyConverterName()
      Gets the value of the currencyConverterName property.
      Returns:
      possible object is String

    • isSetCurrencyConverterName

      public boolean isSetCurrencyConverterName()

    • getCurrencyConverterOrganizationName

      public java.lang.String getCurrencyConverterOrganizationName()
      Gets the value of the currencyConverterOrganizationName property.
      Returns:
      possible object is String

    • isSetCurrencyConverterOrganizationName

      public boolean isSetCurrencyConverterOrganizationName()

    • getCurrencyConverterOrganizationEnterpriseName

      public java.lang.String getCurrencyConverterOrganizationEnterpriseName()
      Gets the value of the currencyConverterOrganizationEnterpriseName property.
      Returns:
      possible object is String

    • isSetCurrencyConverterOrganizationEnterpriseName

      public boolean isSetCurrencyConverterOrganizationEnterpriseName()

    • getFromCurrency

      public java.lang.String getFromCurrency()
      Gets the value of the fromCurrency property.
      Returns:
      possible object is String

    • setFromCurrency

      public void setFromCurrency​(java.lang.String value)
      Sets the value of the fromCurrency property.
      Parameters:
      value - allowed object is String

    • isSetFromCurrency

      public boolean isSetFromCurrency()

    • getToCurrency

      public java.lang.String getToCurrency()
      Gets the value of the toCurrency property.
      Returns:
      possible object is String

    • setToCurrency

      public void setToCurrency​(java.lang.String value)
      Sets the value of the toCurrency property.
      Parameters:
      value - allowed object is String

    • isSetToCurrency

      public boolean isSetToCurrency()

    • getEffectiveStartInclusive

      public java.util.Calendar getEffectiveStartInclusive()
      Gets the value of the effectiveStartInclusive property.
      Returns:
      possible object is String

    • setEffectiveStartInclusive

      public void setEffectiveStartInclusive​(java.util.Calendar value)
      Sets the value of the effectiveStartInclusive property.
      Parameters:
      value - allowed object is String

    • isSetEffectiveStartInclusive

      public boolean isSetEffectiveStartInclusive()

    • getEffectiveEndExclusive

      public java.util.Calendar getEffectiveEndExclusive()
      Gets the value of the effectiveEndExclusive property.
      Returns:
      possible object is String

    • setEffectiveEndExclusive

      public void setEffectiveEndExclusive​(java.util.Calendar value)
      Sets the value of the effectiveEndExclusive property.
      Parameters:
      value - allowed object is String

    • isSetEffectiveEndExclusive

      public boolean isSetEffectiveEndExclusive()

    • setFactor

      public void setFactor​(float value)
      Sets the value of the factor property.
      Parameters:
      value - allowed object is String

    • isSetFactor

      public boolean isSetFactor()

    • getUdfs

      public com.onenetwork.platform.common.NameValuePairList getUdfs()
      Gets the value of the udfs property.
      Overrides:
      getUdfs in class com.onenetwork.platform.common.Model
      Returns:
      possible object is NameValuePairList

    • setUdfs

      public void setUdfs​(com.onenetwork.platform.common.NameValuePairList value)
      Sets the value of the udfs property.
      Overrides:
      setUdfs in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is NameValuePairList

    • isSetUdfs

      public boolean isSetUdfs()
      Overrides:
      isSetUdfs in class com.onenetwork.platform.common.Model

    • getMDFsList

      public java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> getMDFsList()
      Gets the value of the mdFsList property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mdFsList property.

      For example, to add a new item, do as follows: 

          getMDFsList().add(newItem);

      Objects of the following type(s) are allowed in the list JAXBElement<DummyMDFs> JAXBElement<MDFs>

      Overrides:
      getMDFsList in class com.onenetwork.platform.common.Model

    • isSetMDFsList

      public boolean isSetMDFsList()

    • unsetMDFsList

      public void unsetMDFsList()

    • getAttributes

      public java.util.List<AttributeValue> getAttributes()
      Gets the value of the attributes property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributes property.

      For example, to add a new item, do as follows: 

          getAttributes().add(newItem);

      Objects of the following type(s) are allowed in the list AttributeValue

      Overrides:
      getAttributes in class com.onenetwork.platform.common.Model

    • isSetAttributes

      public boolean isSetAttributes()

    • unsetAttributes

      public void unsetAttributes()

    • setCurrencyConverterName

      public void setCurrencyConverterName​(java.lang.String value)
      Sets the value of CurrencyConverterName, and also nullifies the following surrogate ids: SysCurrencyConverterId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for CurrencyConverterName - the following will also be nullified: SysCurrencyConverterId

    • setCurrencyConverterOrganizationName

      public void setCurrencyConverterOrganizationName​(java.lang.String value)
      Sets the value of CurrencyConverterOrganizationName, and also nullifies the following surrogate ids: SysCurrencyConverterId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for CurrencyConverterOrganizationName - the following will also be nullified: SysCurrencyConverterId

    • setCurrencyConverterOrganizationEnterpriseName

      public void setCurrencyConverterOrganizationEnterpriseName​(java.lang.String value)
      Sets the value of CurrencyConverterOrganizationEnterpriseName, and also nullifies the following surrogate ids: SysCurrencyConverterId. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for CurrencyConverterOrganizationEnterpriseName - the following will also be nullified: SysCurrencyConverterId

    • getFactor

      public float getFactor()

    • unsetFactor

      public void unsetFactor()

    • equals

      public boolean equals​(java.lang.Object obj)
      Description copied from interface: Model
      A Model object is considered "equal" to another Model object if it is a Model of the same type and its Natural Key fields are identical.
      Specified by:
      equals in interface Model
      Overrides:
      equals in class java.lang.Object
      Parameters:
      obj - object to compare
      Returns:
      true if the object is the same type of Model with identical Natural Key fields

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • internalToString

      protected java.lang.String internalToString()
      Overrides:
      internalToString in class com.onenetwork.platform.common.Model

    • toStrContrib

      public java.lang.String toStrContrib()
      Not intended for use by Clients

    • getModelType

      public com.onenetwork.platform.data.model.impl.ModelType getModelType()
      methods to get ModelType for this JAXB.
      Overrides:
      getModelType in class com.onenetwork.platform.common.Model

    • getModelLevelType

      public com.onenetwork.platform.data.model.impl.ModelLevelType getModelLevelType()
      methods to get ModelLevelType for this JAXB.
      Overrides:
      getModelLevelType in class com.onenetwork.platform.common.Model

    • getStandardModelName

      public java.lang.String getStandardModelName()
      method to get standard model name for this JAXB.
      Overrides:
      getStandardModelName in class com.onenetwork.platform.common.Model

    • getSysCurrencyConverterId

      public java.lang.Long getSysCurrencyConverterId()
      Returns the surrogate id value for SysCurrencyConverterId. After reading a model, this will always match with the corresponding natural keys, which are: currencyConverterName, currencyConverterOrganizationName, currencyConverterOrganizationEnterpriseName

    • setSysCurrencyConverterId

      public void setSysCurrencyConverterId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysCurrencyConverterId. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: currencyConverterName, currencyConverterOrganizationName, currencyConverterOrganizationEnterpriseName. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysCurrencyConverterId
      nullifyNaturalKeys - true to nullify the related natural keys (currencyConverterName, currencyConverterOrganizationName, currencyConverterOrganizationEnterpriseName), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both