Package cdm.base.datetime

Interface RelativeTimeOffset

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

RelativeTime, RelativeTime.RelativeTimeBuilder, RelativeTimeOffset.RelativeTimeOffsetBuilder

All Known Implementing Classes:

RelativeTime.RelativeTimeBuilderImpl, RelativeTime.RelativeTimeImpl, RelativeTimeOffset.RelativeTimeOffsetBuilderImpl, RelativeTimeOffset.RelativeTimeOffsetImpl

@RosettaDataType(value="RelativeTimeOffset",
                 builder=RelativeTimeOffsetBuilderImpl.class,
                 version="7.0.0-dev.105")
@RuneDataType(value="RelativeTimeOffset",
              model="cdm",
              builder=RelativeTimeOffsetBuilderImpl.class,
              version="7.0.0-dev.105")
public interface RelativeTimeOffset
extends com.rosetta.model.lib.RosettaModelObject

Describes how a time is offset from a reference point, including the unit, magnitude, and rounding behavior.

Version:

7.0.0-dev.105

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RelativeTimeOffset.RelativeTimeOffsetBuilder	Builder Interface
static class	RelativeTimeOffset.RelativeTimeOffsetBuilderImpl	Builder Implementation of RelativeTimeOffset
static class	RelativeTimeOffset.RelativeTimeOffsetImpl	Immutable Implementation of RelativeTimeOffset

Field Summary

Fields

Modifier and Type	Field	Description
static final RelativeTimeOffsetMeta	metaData

Method Summary

Modifier and Type	Method	Description
RelativeTimeOffset	build()	Build Methods
static RelativeTimeOffset.RelativeTimeOffsetBuilder	builder()
Integer	getOffsetMultiplier()	A time offset multiplier, e.g. 1, 2 or 3 etc.
TimeUnitEnum	getOffsetTimeUnit()	The unit of time for the offset (e.g., seconds, minutes, hours, days).
TimeRounding	getRounding()	Optional rules that define how the calculated time should be rounded after the offset has been applied.
default Class<? extends RelativeTimeOffset>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends RelativeTimeOffset>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
RelativeTimeOffset.RelativeTimeOffsetBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final RelativeTimeOffsetMeta metaData

Method Details

getOffsetTimeUnit

TimeUnitEnum getOffsetTimeUnit()

The unit of time for the offset (e.g., seconds, minutes, hours, days).

getOffsetMultiplier

Integer getOffsetMultiplier()

A time offset multiplier, e.g. 1, 2 or 3 etc. A negative value can be used when specifying a negative offset, e.g. -2 hours.

getRounding

TimeRounding getRounding()

Optional rules that define how the calculated time should be rounded after the offset has been applied.

build

RelativeTimeOffset build()

Build Methods

Specified by:

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

toBuilder

RelativeTimeOffset.RelativeTimeOffsetBuilder toBuilder()

Specified by:

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

builder

static RelativeTimeOffset.RelativeTimeOffsetBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

@RuneAttribute("@type")
default Class<? extends RelativeTimeOffset> 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