Package cdm.base.math

Interface QuantitySchedule

All Superinterfaces:

MeasureBase, MeasureSchedule, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

Money, Money.MoneyBuilder, NonNegativeQuantity, NonNegativeQuantity.NonNegativeQuantityBuilder, NonNegativeQuantitySchedule, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilder, Quantity, Quantity.QuantityBuilder, QuantitySchedule.QuantityScheduleBuilder

All Known Implementing Classes:

Money.MoneyBuilderImpl, Money.MoneyImpl, NonNegativeQuantity.NonNegativeQuantityBuilderImpl, NonNegativeQuantity.NonNegativeQuantityImpl, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilderImpl, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleImpl, Quantity.QuantityBuilderImpl, Quantity.QuantityImpl, QuantitySchedule.QuantityScheduleBuilderImpl, QuantitySchedule.QuantityScheduleImpl

@RosettaDataType(value="QuantitySchedule",
                 builder=QuantityScheduleBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="QuantitySchedule",
              model="cdm",
              builder=QuantityScheduleBuilderImpl.class,
              version="5.30.0")
public interface QuantitySchedule
extends MeasureSchedule

Specifies a quantity schedule to be associated to a financial product to represent a trade amount. This data type extends MeasureSchedule with several unit or multiplier attributes that are used to define financial quantities. This data type is generically based on a schedule and can also be used to represent a quantity as a single value.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QuantitySchedule.QuantityScheduleBuilder	Builder Interface
static class	QuantitySchedule.QuantityScheduleBuilderImpl	Builder Implementation of QuantitySchedule
static class	QuantitySchedule.QuantityScheduleImpl	Immutable Implementation of QuantitySchedule

Nested classes/interfaces inherited from interface cdm.base.math.MeasureBase

MeasureBase.MeasureBaseBuilder, MeasureBase.MeasureBaseBuilderImpl, MeasureBase.MeasureBaseImpl

Nested classes/interfaces inherited from interface cdm.base.math.MeasureSchedule

MeasureSchedule.MeasureScheduleBuilder, MeasureSchedule.MeasureScheduleBuilderImpl, MeasureSchedule.MeasureScheduleImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final QuantityScheduleMeta	metaData

Method Summary

Modifier and Type	Method	Description
QuantitySchedule	build()	Build Methods
static QuantitySchedule.QuantityScheduleBuilder	builder()
Frequency	getFrequency()	Defines the frequency to be used when defining a quantity.
Measure	getMultiplier()	Defines an optional number that the quantity should be multiplied by to derive a total quantity.
default Class<? extends QuantitySchedule>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends QuantitySchedule>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
QuantitySchedule.QuantityScheduleBuilder	toBuilder()

Methods inherited from interface cdm.base.math.MeasureBase

getUnit, getValue

Methods inherited from interface cdm.base.math.MeasureSchedule

getDatedValue

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Field Details

metaData

static final QuantityScheduleMeta metaData

Method Details

getMultiplier

Measure getMultiplier()

Defines an optional number that the quantity should be multiplied by to derive a total quantity. This number is associated to a unit. For example in the case of the Coal (API2) CIF ARA (ARGUS-McCloskey) Futures Contract on the CME, where the unit would be contracts, the multiplier value would 1,000 and the mulitiplier unit would be 1,000 MT (Metric Tons).

getFrequency

Frequency getFrequency()

Defines the frequency to be used when defining a quantity. For example a quantity may be specified as a number of barrels of oil per day, which needs multiplying by the number of days in the relevant period to get the total quantity as a number of barrels.

build

QuantitySchedule build()

Build Methods

Specified by:

build in interface MeasureBase

Specified by:

build in interface MeasureSchedule

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

toBuilder

QuantitySchedule.QuantityScheduleBuilder toBuilder()

Specified by:

toBuilder in interface MeasureBase

Specified by:

toBuilder in interface MeasureSchedule

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

builder

static QuantitySchedule.QuantityScheduleBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends QuantitySchedule> metaData()

Utility Methods

Specified by:

metaData in interface MeasureBase

Specified by:

metaData in interface MeasureSchedule

Specified by:

metaData in interface com.rosetta.model.lib.RosettaModelObject

getType

@RuneAttribute("@type")
default Class<? extends QuantitySchedule> getType()

Specified by:

getType in interface MeasureBase

Specified by:

getType in interface MeasureSchedule

Specified by:

getType in interface com.rosetta.model.lib.RosettaModelObject

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.Processor processor)

Specified by:

process in interface MeasureBase

Specified by:

process in interface MeasureSchedule

Specified by:

process in interface com.rosetta.model.lib.RosettaModelObject