Package cdm.base.datetime

Interface Offset

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, Period, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

AdjustedRelativeDateOffset, AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetBuilder, FxFixingDate, FxFixingDate.FxFixingDateBuilder, Offset.OffsetBuilder, RelativeDateOffset, RelativeDateOffset.RelativeDateOffsetBuilder, RelativeDates, RelativeDates.RelativeDatesBuilder

All Known Implementing Classes:

AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetBuilderImpl, AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetImpl, FxFixingDate.FxFixingDateBuilderImpl, FxFixingDate.FxFixingDateImpl, Offset.OffsetBuilderImpl, Offset.OffsetImpl, RelativeDateOffset.RelativeDateOffsetBuilderImpl, RelativeDateOffset.RelativeDateOffsetImpl, RelativeDates.RelativeDatesBuilderImpl, RelativeDates.RelativeDatesImpl

@RosettaDataType(value="Offset",
                 builder=OffsetBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="Offset",
              model="cdm",
              builder=OffsetBuilderImpl.class,
              version="5.30.0")
public interface Offset
extends Period

A class defining an offset used in calculating a new date relative to a reference date, e.g. calendar days, business days, commodity Business days, etc.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Offset.OffsetBuilder	Builder Interface
static class	Offset.OffsetBuilderImpl	Builder Implementation of Offset
static class	Offset.OffsetImpl	Immutable Implementation of Offset

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Nested classes/interfaces inherited from interface cdm.base.datetime.Period

Period.PeriodBuilder, Period.PeriodBuilderImpl, Period.PeriodImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final OffsetMeta	metaData

Method Summary

Modifier and Type	Method	Description
Offset	build()	Build Methods
static Offset.OffsetBuilder	builder()
DayTypeEnum	getDayType()	In the case of an offset specified as a number of days, this element defines whether consideration is given as to whether a day is a good business day or not.
default Class<? extends Offset>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends Offset>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Offset.OffsetBuilder	toBuilder()

Methods inherited from interface cdm.base.datetime.Period

getMeta, getPeriod, getPeriodMultiplier

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

processRosetta, processRosetta

Field Details

metaData

static final OffsetMeta metaData

Method Details

getDayType

DayTypeEnum getDayType()

In the case of an offset specified as a number of days, this element defines whether consideration is given as to whether a day is a good business day or not. If a day type of business days is specified then non-business days are ignored when calculating the offset. The financial business centers to use for determination of business days are implied by the context in which this element is used. This element must only be included when the offset is specified as a number of days. If the offset is zero days then the dayType element should not be included.

build

Offset build()

Build Methods

Specified by:

build in interface Period

Specified by:

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

toBuilder

Offset.OffsetBuilder toBuilder()

Specified by:

toBuilder in interface Period

Specified by:

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

builder

static Offset.OffsetBuilder builder()

metaData

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

Utility Methods

Specified by:

metaData in interface Period

Specified by:

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

getType

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

Specified by:

getType in interface Period

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 Period

Specified by:

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