Package cdm.event.workflow

Class EventInstruction.EventInstructionBuilderImpl

java.lang.Object

cdm.event.workflow.EventInstruction.EventInstructionBuilderImpl

All Implemented Interfaces:

EventInstruction, EventInstruction.EventInstructionBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Direct Known Subclasses:

BusinessEvent.BusinessEventBuilderImpl

Enclosing interface:

EventInstruction

public static class EventInstruction.EventInstructionBuilderImpl
extends Object
implements EventInstruction.EventInstructionBuilder

Builder Implementation of EventInstruction

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.event.workflow.EventInstruction

EventInstruction.EventInstructionBuilder, EventInstruction.EventInstructionBuilderImpl, EventInstruction.EventInstructionImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected CorporateActionTypeEnum	corporateActionIntent
protected com.rosetta.model.lib.records.Date	effectiveDate
protected com.rosetta.model.lib.records.Date	eventDate
protected List<Instruction.InstructionBuilder>	instruction
protected EventIntentEnum	intent
protected IdentifiedList.IdentifiedListBuilder	packageInformation

Fields inherited from interface cdm.event.workflow.EventInstruction

metaData

Constructor Summary

Constructors

Constructor	Description
EventInstructionBuilderImpl()

Method Summary

Modifier and Type	Method	Description
EventInstruction.EventInstructionBuilder	addInstruction(Instruction _instruction)
EventInstruction.EventInstructionBuilder	addInstruction(Instruction _instruction, int idx)
EventInstruction.EventInstructionBuilder	addInstruction(List<? extends Instruction> instructions)
EventInstruction	build()	Build Methods
boolean	equals(Object o)
CorporateActionTypeEnum	getCorporateActionIntent()
com.rosetta.model.lib.records.Date	getEffectiveDate()	The date on which the event contractually takes effect, when different from the event date.
com.rosetta.model.lib.records.Date	getEventDate()	Specifies the date on which the event is taking place.
List<? extends Instruction.InstructionBuilder>	getInstruction()	Specifies the instructions to create the Business Event.
EventIntentEnum	getIntent()	The intent attribute is meant to be specified when the event qualification cannot be programmatically inferred from the event features.
Instruction.InstructionBuilder	getOrCreateInstruction(int index)
IdentifiedList.IdentifiedListBuilder	getOrCreatePackageInformation()
IdentifiedList.IdentifiedListBuilder	getPackageInformation()	Specifies the package information in case the business event represents several trades executed as a package (hence this attribute is optional).
boolean	hasData()
int	hashCode()
EventInstruction.EventInstructionBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
EventInstruction.EventInstructionBuilder	prune()
EventInstruction.EventInstructionBuilder	setCorporateActionIntent(CorporateActionTypeEnum _corporateActionIntent)
EventInstruction.EventInstructionBuilder	setEffectiveDate(com.rosetta.model.lib.records.Date _effectiveDate)
EventInstruction.EventInstructionBuilder	setEventDate(com.rosetta.model.lib.records.Date _eventDate)
EventInstruction.EventInstructionBuilder	setInstruction(List<? extends Instruction> instructions)
EventInstruction.EventInstructionBuilder	setIntent(EventIntentEnum _intent)
EventInstruction.EventInstructionBuilder	setPackageInformation(IdentifiedList _packageInformation)
EventInstruction.EventInstructionBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdm.event.workflow.EventInstruction

getType, metaData, process

Methods inherited from interface cdm.event.workflow.EventInstruction.EventInstructionBuilder

process

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

processRosetta, processRosetta

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

getIndex, processRosetta, processRosetta

Field Details

intent

protected EventIntentEnum intent

corporateActionIntent

protected CorporateActionTypeEnum corporateActionIntent

eventDate

protected com.rosetta.model.lib.records.Date eventDate

effectiveDate

protected com.rosetta.model.lib.records.Date effectiveDate

packageInformation

protected IdentifiedList.IdentifiedListBuilder packageInformation

instruction

protected List<Instruction.InstructionBuilder> instruction

Constructor Details

EventInstructionBuilderImpl

public EventInstructionBuilderImpl()

Method Details

getIntent

@RosettaAttribute("intent")
@RuneAttribute("intent")
public EventIntentEnum getIntent()

Description copied from interface: EventInstruction

The intent attribute is meant to be specified when the event qualification cannot be programmatically inferred from the event features. As a result it is only associated with those primitives that can give way to such ambiguity, the quantityChange being one of those. An example of such is a reduction in the trade notional, which could be interpreted as either a trade correction (unless a maximum period of time post-event is specified as part of the qualification), a partial termination or a portfolio rebalancing in the case of an equity swap. On the other hand, an event such as the exercise is not expected to have an associated intent as there should not be ambiguity.

Specified by:

getIntent in interface EventInstruction

getCorporateActionIntent

@RosettaAttribute("corporateActionIntent")
@RuneAttribute("corporateActionIntent")
public CorporateActionTypeEnum getCorporateActionIntent()

Specified by:

getCorporateActionIntent in interface EventInstruction

getEventDate

@RosettaAttribute("eventDate")
@RuneAttribute("eventDate")
public com.rosetta.model.lib.records.Date getEventDate()

Description copied from interface: EventInstruction

Specifies the date on which the event is taking place. This date is equal to the trade date in the case of a simple execution. However it can be different from the trade date, for example in the case of a partial termination.

Specified by:

getEventDate in interface EventInstruction

getEffectiveDate

@RosettaAttribute("effectiveDate")
@RuneAttribute("effectiveDate")
public com.rosetta.model.lib.records.Date getEffectiveDate()

Description copied from interface: EventInstruction

The date on which the event contractually takes effect, when different from the event date.

Specified by:

getEffectiveDate in interface EventInstruction

getPackageInformation

@RosettaAttribute("packageInformation")
@RuneAttribute("packageInformation")
public IdentifiedList.IdentifiedListBuilder getPackageInformation()

Description copied from interface: EventInstruction

Specifies the package information in case the business event represents several trades executed as a package (hence this attribute is optional). The package information is only instantiated once at the business event level to preserve referential integrity, whereas individual trades make reference to it to identify that they are part of a package.

Specified by:

getPackageInformation in interface EventInstruction

Specified by:

getPackageInformation in interface EventInstruction.EventInstructionBuilder

getOrCreatePackageInformation

public IdentifiedList.IdentifiedListBuilder getOrCreatePackageInformation()

Specified by:

getOrCreatePackageInformation in interface EventInstruction.EventInstructionBuilder

getInstruction

@RosettaAttribute("instruction")
@RuneAttribute("instruction")
public List<? extends Instruction.InstructionBuilder> getInstruction()

Description copied from interface: EventInstruction

Specifies the instructions to create the Business Event.

Specified by:

getInstruction in interface EventInstruction

Specified by:

getInstruction in interface EventInstruction.EventInstructionBuilder

getOrCreateInstruction

public Instruction.InstructionBuilder getOrCreateInstruction(int index)

Specified by:

getOrCreateInstruction in interface EventInstruction.EventInstructionBuilder

setIntent

@RosettaAttribute("intent")
@RuneAttribute("intent")
public EventInstruction.EventInstructionBuilder setIntent(EventIntentEnum _intent)

Specified by:

setIntent in interface EventInstruction.EventInstructionBuilder

setCorporateActionIntent

@RosettaAttribute("corporateActionIntent")
@RuneAttribute("corporateActionIntent")
public EventInstruction.EventInstructionBuilder setCorporateActionIntent(CorporateActionTypeEnum _corporateActionIntent)

Specified by:

setCorporateActionIntent in interface EventInstruction.EventInstructionBuilder

setEventDate

@RosettaAttribute("eventDate")
@RuneAttribute("eventDate")
public EventInstruction.EventInstructionBuilder setEventDate(com.rosetta.model.lib.records.Date _eventDate)

Specified by:

setEventDate in interface EventInstruction.EventInstructionBuilder

setEffectiveDate

@RosettaAttribute("effectiveDate")
@RuneAttribute("effectiveDate")
public EventInstruction.EventInstructionBuilder setEffectiveDate(com.rosetta.model.lib.records.Date _effectiveDate)

Specified by:

setEffectiveDate in interface EventInstruction.EventInstructionBuilder

setPackageInformation

@RosettaAttribute("packageInformation")
@RuneAttribute("packageInformation")
public EventInstruction.EventInstructionBuilder setPackageInformation(IdentifiedList _packageInformation)

Specified by:

setPackageInformation in interface EventInstruction.EventInstructionBuilder

addInstruction

@RosettaAttribute("instruction")
@RuneAttribute("instruction")
public EventInstruction.EventInstructionBuilder addInstruction(Instruction _instruction)

Specified by:

addInstruction in interface EventInstruction.EventInstructionBuilder

addInstruction

public EventInstruction.EventInstructionBuilder addInstruction(Instruction _instruction,
 int idx)

Specified by:

addInstruction in interface EventInstruction.EventInstructionBuilder

addInstruction

public EventInstruction.EventInstructionBuilder addInstruction(List<? extends Instruction> instructions)

Specified by:

addInstruction in interface EventInstruction.EventInstructionBuilder

setInstruction

@RuneAttribute("instruction")
public EventInstruction.EventInstructionBuilder setInstruction(List<? extends Instruction> instructions)

Specified by:

setInstruction in interface EventInstruction.EventInstructionBuilder

build

public EventInstruction build()

Description copied from interface: EventInstruction

Build Methods

Specified by:

build in interface EventInstruction

Specified by:

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

toBuilder

public EventInstruction.EventInstructionBuilder toBuilder()

Specified by:

toBuilder in interface EventInstruction

Specified by:

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

prune

public EventInstruction.EventInstructionBuilder prune()

Specified by:

prune in interface EventInstruction.EventInstructionBuilder

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder

hasData

public boolean hasData()

Specified by:

hasData in interface com.rosetta.model.lib.RosettaModelObjectBuilder

merge

public EventInstruction.EventInstructionBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

merge in interface com.rosetta.model.lib.RosettaModelObjectBuilder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object