Package cdm.event.common

Interface ReturnInstruction

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

ReturnInstruction.ReturnInstructionBuilder

All Known Implementing Classes:

ReturnInstruction.ReturnInstructionBuilderImpl, ReturnInstruction.ReturnInstructionImpl

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

Specifies the information required to create the return of a Security Finance Transaction.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ReturnInstruction.ReturnInstructionBuilder	Builder Interface
static class	ReturnInstruction.ReturnInstructionBuilderImpl	Builder Implementation of ReturnInstruction
static class	ReturnInstruction.ReturnInstructionImpl	Immutable Implementation of ReturnInstruction

Field Summary

Fields

Modifier and Type	Field	Description
static final ReturnInstructionMeta	metaData

Method Summary

Modifier and Type	Method	Description
ReturnInstruction	build()	Build Methods
static ReturnInstruction.ReturnInstructionBuilder	builder()
List<? extends Quantity>	getQuantity()	Specifies the quantity of shares and cash to be returned in a partial return event.
default Class<? extends ReturnInstruction>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends ReturnInstruction>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
ReturnInstruction.ReturnInstructionBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final ReturnInstructionMeta metaData

Method Details

getQuantity

List<? extends Quantity> getQuantity()

Specifies the quantity of shares and cash to be returned in a partial return event.

build

ReturnInstruction build()

Build Methods

Specified by:

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

toBuilder

ReturnInstruction.ReturnInstructionBuilder toBuilder()

Specified by:

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

builder

static ReturnInstruction.ReturnInstructionBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

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