Package cdm.base.staticdata.identifier

Interface IdentifiedList

All Superinterfaces:

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

All Known Subinterfaces:

IdentifiedList.IdentifiedListBuilder

All Known Implementing Classes:

IdentifiedList.IdentifiedListBuilderImpl, IdentifiedList.IdentifiedListImpl

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

Attaches an identifier to a collection of objects, when those objects themselves can each be represented by an identifier. One use case is the representation of package transactions, where each component is a separate trade with its own identifier, and those trades are linked together as a package with its own identifier. The data type has been named generically rather than referring to 'packages' as it may have a number of other uses.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IdentifiedList.IdentifiedListBuilder	Builder Interface
static class	IdentifiedList.IdentifiedListBuilderImpl	Builder Implementation of IdentifiedList
static class	IdentifiedList.IdentifiedListImpl	Immutable Implementation of IdentifiedList

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

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final IdentifiedListMeta	metaData

Method Summary

Modifier and Type	Method	Description
IdentifiedList	build()	Build Methods
static IdentifiedList.IdentifiedListBuilder	builder()
List<? extends Identifier>	getComponentId()	Identifier(s) for each component of the list.
Identifier	getListId()	The identifier for the list.
com.rosetta.model.metafields.MetaFields	getMeta()
Price	getPrice()	The price of the package.
default Class<? extends IdentifiedList>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends IdentifiedList>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
IdentifiedList.IdentifiedListBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final IdentifiedListMeta metaData

Method Details

getListId

Identifier getListId()

The identifier for the list. In the case of a package transaction, this would be the package identifier. This attribute is mandatory to allow the list itself to be identified.

getComponentId

List<? extends Identifier> getComponentId()

Identifier(s) for each component of the list. Since the data type is used to link multiple identified objects together, at least 1 component is required in the list at the inception of the Trade. As the trade progresses, this element is expected to contain multiple component Ids.

getPrice

Price getPrice()

The price of the package.

getMeta

com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

build

IdentifiedList build()

Build Methods

Specified by:

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

toBuilder

IdentifiedList.IdentifiedListBuilder toBuilder()

Specified by:

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

builder

static IdentifiedList.IdentifiedListBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

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