Package cdm.base.staticdata.asset.common

Interface CommodityReferenceFramework

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

CommodityReferenceFramework.CommodityReferenceFrameworkBuilder

All Known Implementing Classes:

CommodityReferenceFramework.CommodityReferenceFrameworkBuilderImpl, CommodityReferenceFramework.CommodityReferenceFrameworkImpl

@RosettaDataType(value="CommodityReferenceFramework",
                 builder=CommodityReferenceFrameworkBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="CommodityReferenceFramework",
              model="cdm",
              builder=CommodityReferenceFrameworkBuilderImpl.class,
              version="5.30.0")
public interface CommodityReferenceFramework
extends com.rosetta.model.lib.RosettaModelObject

Specifies the type of commodity.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CommodityReferenceFramework.CommodityReferenceFrameworkBuilder	Builder Interface
static class	CommodityReferenceFramework.CommodityReferenceFrameworkBuilderImpl	Builder Implementation of CommodityReferenceFramework
static class	CommodityReferenceFramework.CommodityReferenceFrameworkImpl	Immutable Implementation of CommodityReferenceFramework

Field Summary

Fields

Modifier and Type	Field	Description
static final CommodityReferenceFrameworkMeta	metaData

Method Summary

Modifier and Type	Method	Description
CommodityReferenceFramework	build()	Build Methods
static CommodityReferenceFramework.CommodityReferenceFrameworkBuilder	builder()
CapacityUnitEnum	getCapacityUnit()	Provides an enumerated value for a capacity unit, generally used in the context of defining quantities for commodities.
String	getCommodityName()	Identifies the commodity more specifically.
FieldWithMetaString	getCurrency()	Defines the currency in which the commodity is priced.
default Class<? extends CommodityReferenceFramework>	getType()
WeatherUnitEnum	getWeatherUnit()	Provides an enumerated values for a weather unit, generally used in the context of defining quantities for commodities.
default com.rosetta.model.lib.meta.RosettaMetaData<? extends CommodityReferenceFramework>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
CommodityReferenceFramework.CommodityReferenceFrameworkBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final CommodityReferenceFrameworkMeta metaData

Method Details

getCommodityName

String getCommodityName()

Identifies the commodity more specifically. Where possible, this should follow the naming convention used in the 2005 ISDA Commodity Definitions SubAnnex A, including the subCommodity and additional qualifiers, but should be limited to 256 characters or less.

getCapacityUnit

CapacityUnitEnum getCapacityUnit()

Provides an enumerated value for a capacity unit, generally used in the context of defining quantities for commodities.

getWeatherUnit

WeatherUnitEnum getWeatherUnit()

Provides an enumerated values for a weather unit, generally used in the context of defining quantities for commodities.

getCurrency

FieldWithMetaString getCurrency()

Defines the currency in which the commodity is priced.

build

CommodityReferenceFramework build()

Build Methods

Specified by:

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

toBuilder

CommodityReferenceFramework.CommodityReferenceFrameworkBuilder toBuilder()

Specified by:

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

builder

static CommodityReferenceFramework.CommodityReferenceFrameworkBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

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

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 com.rosetta.model.lib.RosettaModelObject