Class RelativeDateOffset
java.lang.Object
net.finmath.smartcontract.product.xml.Period
net.finmath.smartcontract.product.xml.Offset
net.finmath.smartcontract.product.xml.RelativeDateOffset
- Direct Known Subclasses:
AdjustedRelativeDateOffset
,RelativeDates
A type defining a date (referred to as the derived date) as a relative
offset from another date (referred to as the anchor date). If the anchor date is itself an adjustable
date then the offset is assumed to be calculated from the adjusted anchor date. A number of different
scenarios can be supported, namely; 1) the derived date may simply be a number of calendar periods
(days, weeks, months or years) preceding or following the anchor date; 2) the unadjusted derived date
may be a number of calendar periods (days, weeks, months or years) preceding or following the anchor
date with the resulting unadjusted derived date subject to adjustment in accordance with a specified
business day convention, i.e. the derived date must fall on a good business day; 3) the derived date may
be a number of business days preceding or following the anchor date. Note that the businessDayConvention
specifies any required adjustment to the unadjusted derived date. A negative or positive value in the
periodMultiplier indicates whether the unadjusted derived precedes or follows the anchor date. The
businessDayConvention should contain a value NONE if the day type element contains a value of Business
(since specifying a negative or positive business days offset would already guarantee that the derived
date would fall on a good business day in the specified business centers).
Java class for RelativeDateOffset complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="RelativeDateOffset"> <complexContent> <extension base="{http://www.fpml.org/FpML-5/confirmation}Offset"> <sequence> <element name="businessDayConvention" type="{http://www.fpml.org/FpML-5/confirmation}BusinessDayConventionEnum"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}BusinessCentersOrReference.model" minOccurs="0"/> <element name="dateRelativeTo" type="{http://www.fpml.org/FpML-5/confirmation}DateReference"/> <element name="adjustedDate" type="{http://www.fpml.org/FpML-5/confirmation}IdentifiedDate" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
-
Field Summary
Modifier and TypeFieldDescriptionprotected IdentifiedDate
protected BusinessCenters
protected BusinessCentersReference
protected BusinessDayConventionEnum
protected DateReference
Fields inherited from class net.finmath.smartcontract.product.xml.Period
id, period, periodMultiplier
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the value of the adjustedDate property.Gets the value of the businessCenters property.Gets the value of the businessCentersReference property.Gets the value of the businessDayConvention property.Gets the value of the dateRelativeTo property.void
setAdjustedDate
(IdentifiedDate value) Sets the value of the adjustedDate property.void
Sets the value of the businessCenters property.void
Sets the value of the businessCentersReference property.void
Sets the value of the businessDayConvention property.void
setDateRelativeTo
(DateReference value) Sets the value of the dateRelativeTo property.Methods inherited from class net.finmath.smartcontract.product.xml.Offset
getDayType, setDayType
Methods inherited from class net.finmath.smartcontract.product.xml.Period
getId, getPeriod, getPeriodMultiplier, setId, setPeriod, setPeriodMultiplier
-
Field Details
-
businessDayConvention
-
businessCentersReference
-
businessCenters
-
dateRelativeTo
-
adjustedDate
-
-
Constructor Details
-
RelativeDateOffset
public RelativeDateOffset()
-
-
Method Details
-
getBusinessDayConvention
Gets the value of the businessDayConvention property.- Returns:
- possible object is
BusinessDayConventionEnum
-
setBusinessDayConvention
Sets the value of the businessDayConvention property.- Parameters:
value
- allowed object isBusinessDayConventionEnum
-
getBusinessCentersReference
Gets the value of the businessCentersReference property.- Returns:
- possible object is
BusinessCentersReference
-
setBusinessCentersReference
Sets the value of the businessCentersReference property.- Parameters:
value
- allowed object isBusinessCentersReference
-
getBusinessCenters
Gets the value of the businessCenters property.- Returns:
- possible object is
BusinessCenters
-
setBusinessCenters
Sets the value of the businessCenters property.- Parameters:
value
- allowed object isBusinessCenters
-
getDateRelativeTo
Gets the value of the dateRelativeTo property.- Returns:
- possible object is
DateReference
-
setDateRelativeTo
Sets the value of the dateRelativeTo property.- Parameters:
value
- allowed object isDateReference
-
getAdjustedDate
Gets the value of the adjustedDate property.- Returns:
- possible object is
IdentifiedDate
-
setAdjustedDate
Sets the value of the adjustedDate property.- Parameters:
value
- allowed object isIdentifiedDate
-