Package cdm.event.workflow

Interface WorkflowStep.WorkflowStepBuilder

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder, WorkflowStep

All Known Implementing Classes:

WorkflowStep.WorkflowStepBuilderImpl

Enclosing interface:

WorkflowStep

public static interface WorkflowStep.WorkflowStepBuilder
extends WorkflowStep, com.rosetta.model.lib.RosettaModelObjectBuilder, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Builder Interface

Nested Class Summary

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

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

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

WorkflowStep.WorkflowStepBuilder, WorkflowStep.WorkflowStepBuilderImpl, WorkflowStep.WorkflowStepImpl

Field Summary

Fields inherited from interface cdm.event.workflow.WorkflowStep

metaData

Method Summary

Modifier and Type	Method	Description
WorkflowStep.WorkflowStepBuilder	addAccount(Account account)
WorkflowStep.WorkflowStepBuilder	addAccount(Account account, int idx)
WorkflowStep.WorkflowStepBuilder	addAccount(List<? extends Account> account)
WorkflowStep.WorkflowStepBuilder	addApproval(WorkflowStepApproval approval)
WorkflowStep.WorkflowStepBuilder	addApproval(WorkflowStepApproval approval, int idx)
WorkflowStep.WorkflowStepBuilder	addApproval(List<? extends WorkflowStepApproval> approval)
WorkflowStep.WorkflowStepBuilder	addEventIdentifier(Identifier eventIdentifier)
WorkflowStep.WorkflowStepBuilder	addEventIdentifier(Identifier eventIdentifier, int idx)
WorkflowStep.WorkflowStepBuilder	addEventIdentifier(List<? extends Identifier> eventIdentifier)
WorkflowStep.WorkflowStepBuilder	addParty(Party party)
WorkflowStep.WorkflowStepBuilder	addParty(Party party, int idx)
WorkflowStep.WorkflowStepBuilder	addParty(List<? extends Party> party)
WorkflowStep.WorkflowStepBuilder	addTimestamp(EventTimestamp timestamp)
WorkflowStep.WorkflowStepBuilder	addTimestamp(EventTimestamp timestamp, int idx)
WorkflowStep.WorkflowStepBuilder	addTimestamp(List<? extends EventTimestamp> timestamp)
List<? extends Account.AccountBuilder>	getAccount()	Optional account information that could be associated to the event.
List<? extends WorkflowStepApproval.WorkflowStepApprovalBuilder>	getApproval()	Optional party approvals for the current workflow step.
BusinessEvent.BusinessEventBuilder	getBusinessEvent()	Life cycle event for the step.
CounterpartyPositionBusinessEvent.CounterpartyPositionBusinessEventBuilder	getCounterpartyPositionBusinessEvent()	Documents the life cycle event for a position.
CreditLimitInformation.CreditLimitInformationBuilder	getCreditLimitInformation()
List<? extends Identifier.IdentifierBuilder>	getEventIdentifier()	The identifier(s) that uniquely identify a lifecycle event.
Lineage.LineageBuilder	getLineage()	The lineage attribute provides a linkage among lifecycle events through the globalKey hash value.
MessageInformation.MessageInformationBuilder	getMessageInformation()	Contains all information pertaining the FpML messaging header
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
EventInstruction.EventInstructionBuilder	getNextEvent()	The intended next event can be specified, even if the instructions are not known yet.
Account.AccountBuilder	getOrCreateAccount(int index)
WorkflowStepApproval.WorkflowStepApprovalBuilder	getOrCreateApproval(int index)
BusinessEvent.BusinessEventBuilder	getOrCreateBusinessEvent()
CounterpartyPositionBusinessEvent.CounterpartyPositionBusinessEventBuilder	getOrCreateCounterpartyPositionBusinessEvent()
CreditLimitInformation.CreditLimitInformationBuilder	getOrCreateCreditLimitInformation()
Identifier.IdentifierBuilder	getOrCreateEventIdentifier(int index)
Lineage.LineageBuilder	getOrCreateLineage()
MessageInformation.MessageInformationBuilder	getOrCreateMessageInformation()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
EventInstruction.EventInstructionBuilder	getOrCreateNextEvent()
Party.PartyBuilder	getOrCreateParty(int index)
ReferenceWithMetaWorkflowStep.ReferenceWithMetaWorkflowStepBuilder	getOrCreatePreviousWorkflowStep()
EventInstruction.EventInstructionBuilder	getOrCreateProposedEvent()
EventTimestamp.EventTimestampBuilder	getOrCreateTimestamp(int index)
WorkflowState.WorkflowStateBuilder	getOrCreateWorkflowState()
List<? extends Party.PartyBuilder>	getParty()	The specification of the event parties.
ReferenceWithMetaWorkflowStep.ReferenceWithMetaWorkflowStepBuilder	getPreviousWorkflowStep()	Optional previous workflow step that provides lineage to workflow steps that precedes it.
EventInstruction.EventInstructionBuilder	getProposedEvent()	The proposed event for a workflow step.
List<? extends EventTimestamp.EventTimestampBuilder>	getTimestamp()	The set of timestamp(s) associated with the event as a collection of [dateTime, qualifier].
WorkflowState.WorkflowStateBuilder	getWorkflowState()	The event workflow information, i.e. the workflow status, the associated comment and the partyCustomisedWorkflow which purpose is to provide the ability to associate custom workflow information to the CDM.
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
WorkflowStep.WorkflowStepBuilder	prune()
WorkflowStep.WorkflowStepBuilder	setAccount(List<? extends Account> account)
WorkflowStep.WorkflowStepBuilder	setAction(ActionEnum action)
WorkflowStep.WorkflowStepBuilder	setApproval(List<? extends WorkflowStepApproval> approval)
WorkflowStep.WorkflowStepBuilder	setBusinessEvent(BusinessEvent businessEvent)
WorkflowStep.WorkflowStepBuilder	setCounterpartyPositionBusinessEvent(CounterpartyPositionBusinessEvent counterpartyPositionBusinessEvent)
WorkflowStep.WorkflowStepBuilder	setCreditLimitInformation(CreditLimitInformation creditLimitInformation)
WorkflowStep.WorkflowStepBuilder	setEventIdentifier(List<? extends Identifier> eventIdentifier)
WorkflowStep.WorkflowStepBuilder	setLineage(Lineage lineage)
WorkflowStep.WorkflowStepBuilder	setMessageInformation(MessageInformation messageInformation)
WorkflowStep.WorkflowStepBuilder	setMeta(com.rosetta.model.metafields.MetaFields meta)
WorkflowStep.WorkflowStepBuilder	setNextEvent(EventInstruction nextEvent)
WorkflowStep.WorkflowStepBuilder	setParty(List<? extends Party> party)
WorkflowStep.WorkflowStepBuilder	setPreviousWorkflowStep(ReferenceWithMetaWorkflowStep previousWorkflowStep)
WorkflowStep.WorkflowStepBuilder	setPreviousWorkflowStepValue(WorkflowStep previousWorkflowStep)
WorkflowStep.WorkflowStepBuilder	setProposedEvent(EventInstruction proposedEvent)
WorkflowStep.WorkflowStepBuilder	setRejected(Boolean rejected)
WorkflowStep.WorkflowStepBuilder	setTimestamp(List<? extends EventTimestamp> timestamp)
WorkflowStep.WorkflowStepBuilder	setWorkflowState(WorkflowState workflowState)

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

processRosetta, processRosetta

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

getIndex, hasData, merge, processRosetta, processRosetta

Methods inherited from interface cdm.event.workflow.WorkflowStep

build, getAction, getRejected, getType, metaData, process, toBuilder

Method Details

getOrCreateBusinessEvent

BusinessEvent.BusinessEventBuilder getOrCreateBusinessEvent()

getBusinessEvent

BusinessEvent.BusinessEventBuilder getBusinessEvent()

Description copied from interface: WorkflowStep

Life cycle event for the step. The businessEvent is optional when a proposedEvent or rejection are present.

Specified by:

getBusinessEvent in interface WorkflowStep

getOrCreateCounterpartyPositionBusinessEvent

CounterpartyPositionBusinessEvent.CounterpartyPositionBusinessEventBuilder getOrCreateCounterpartyPositionBusinessEvent()

getCounterpartyPositionBusinessEvent

CounterpartyPositionBusinessEvent.CounterpartyPositionBusinessEventBuilder getCounterpartyPositionBusinessEvent()

Description copied from interface: WorkflowStep

Documents the life cycle event for a position.

Specified by:

getCounterpartyPositionBusinessEvent in interface WorkflowStep

getOrCreateProposedEvent

EventInstruction.EventInstructionBuilder getOrCreateProposedEvent()

getProposedEvent

EventInstruction.EventInstructionBuilder getProposedEvent()

Description copied from interface: WorkflowStep

The proposed event for a workflow step. The proposedEvent is optional when the businessEvent or rejection are present

Specified by:

getProposedEvent in interface WorkflowStep

getOrCreateApproval

WorkflowStepApproval.WorkflowStepApprovalBuilder getOrCreateApproval(int index)

getApproval

List<? extends WorkflowStepApproval.WorkflowStepApprovalBuilder> getApproval()

Description copied from interface: WorkflowStep

Optional party approvals for the current workflow step. A workflow step can have any number of parties associated to it, thus this object is represented as a list. All parties that are expected to provide approval should have an item in this list that references them.

Specified by:

getApproval in interface WorkflowStep

getOrCreatePreviousWorkflowStep

ReferenceWithMetaWorkflowStep.ReferenceWithMetaWorkflowStepBuilder getOrCreatePreviousWorkflowStep()

getPreviousWorkflowStep

ReferenceWithMetaWorkflowStep.ReferenceWithMetaWorkflowStepBuilder getPreviousWorkflowStep()

Description copied from interface: WorkflowStep

Optional previous workflow step that provides lineage to workflow steps that precedes it.

Specified by:

getPreviousWorkflowStep in interface WorkflowStep

getOrCreateNextEvent

EventInstruction.EventInstructionBuilder getOrCreateNextEvent()

getNextEvent

EventInstruction.EventInstructionBuilder getNextEvent()

Description copied from interface: WorkflowStep

The intended next event can be specified, even if the instructions are not known yet.

Specified by:

getNextEvent in interface WorkflowStep

getOrCreateMessageInformation

MessageInformation.MessageInformationBuilder getOrCreateMessageInformation()

getMessageInformation

MessageInformation.MessageInformationBuilder getMessageInformation()

Description copied from interface: WorkflowStep

Contains all information pertaining the FpML messaging header

Specified by:

getMessageInformation in interface WorkflowStep

getOrCreateTimestamp

EventTimestamp.EventTimestampBuilder getOrCreateTimestamp(int index)

getTimestamp

List<? extends EventTimestamp.EventTimestampBuilder> getTimestamp()

Description copied from interface: WorkflowStep

The set of timestamp(s) associated with the event as a collection of [dateTime, qualifier].

Specified by:

getTimestamp in interface WorkflowStep

getOrCreateEventIdentifier

Identifier.IdentifierBuilder getOrCreateEventIdentifier(int index)

getEventIdentifier

List<? extends Identifier.IdentifierBuilder> getEventIdentifier()

Description copied from interface: WorkflowStep

The identifier(s) that uniquely identify a lifecycle event. The unbounded cardinality is meant to provide the ability to associate identifiers that are issued by distinct parties. As an example, each of the parties to the event may choose to associate their own identifiers to the event.

Specified by:

getEventIdentifier in interface WorkflowStep

getOrCreateParty

Party.PartyBuilder getOrCreateParty(int index)

getParty

List<? extends Party.PartyBuilder> getParty()

Description copied from interface: WorkflowStep

The specification of the event parties. This attribute is optional, as not applicable to certain events (e.g. most of the observations).

Specified by:

getParty in interface WorkflowStep

getOrCreateAccount

Account.AccountBuilder getOrCreateAccount(int index)

getAccount

List<? extends Account.AccountBuilder> getAccount()

Description copied from interface: WorkflowStep

Optional account information that could be associated to the event.

Specified by:

getAccount in interface WorkflowStep

getOrCreateLineage

Lineage.LineageBuilder getOrCreateLineage()

getLineage

Lineage.LineageBuilder getLineage()

Description copied from interface: WorkflowStep

The lineage attribute provides a linkage among lifecycle events through the globalKey hash value. One example is when a given lifecycle event is being corrected or cancelled. In such case, each subsequent event will have lineage into the prior version of that event. The second broad use case is when an event has a dependency upon either another event (e.g. the regular payment associated with a fix/float swap will have a lineage into the reset event, which will in turn have a lineage into the observation event for the floating rate and the contract) or a contract (e.g. the exercise of an option has a lineage into that option).

Specified by:

getLineage in interface WorkflowStep

getOrCreateCreditLimitInformation

CreditLimitInformation.CreditLimitInformationBuilder getOrCreateCreditLimitInformation()

getCreditLimitInformation

CreditLimitInformation.CreditLimitInformationBuilder getCreditLimitInformation()

Specified by:

getCreditLimitInformation in interface WorkflowStep

getOrCreateWorkflowState

WorkflowState.WorkflowStateBuilder getOrCreateWorkflowState()

getWorkflowState

WorkflowState.WorkflowStateBuilder getWorkflowState()

Description copied from interface: WorkflowStep

The event workflow information, i.e. the workflow status, the associated comment and the partyCustomisedWorkflow which purpose is to provide the ability to associate custom workflow information to the CDM.

Specified by:

getWorkflowState in interface WorkflowStep

getOrCreateMeta

com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()

Specified by:

getOrCreateMeta in interface com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

getMeta

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

Specified by:

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

Specified by:

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

Specified by:

getMeta in interface WorkflowStep

setBusinessEvent

WorkflowStep.WorkflowStepBuilder setBusinessEvent(BusinessEvent businessEvent)

setCounterpartyPositionBusinessEvent

WorkflowStep.WorkflowStepBuilder setCounterpartyPositionBusinessEvent(CounterpartyPositionBusinessEvent counterpartyPositionBusinessEvent)

setProposedEvent

WorkflowStep.WorkflowStepBuilder setProposedEvent(EventInstruction proposedEvent)

setRejected

WorkflowStep.WorkflowStepBuilder setRejected(Boolean rejected)

addApproval

WorkflowStep.WorkflowStepBuilder addApproval(WorkflowStepApproval approval)

addApproval

WorkflowStep.WorkflowStepBuilder addApproval(WorkflowStepApproval approval,
 int idx)

addApproval

WorkflowStep.WorkflowStepBuilder addApproval(List<? extends WorkflowStepApproval> approval)

setApproval

WorkflowStep.WorkflowStepBuilder setApproval(List<? extends WorkflowStepApproval> approval)

setPreviousWorkflowStep

WorkflowStep.WorkflowStepBuilder setPreviousWorkflowStep(ReferenceWithMetaWorkflowStep previousWorkflowStep)

setPreviousWorkflowStepValue

WorkflowStep.WorkflowStepBuilder setPreviousWorkflowStepValue(WorkflowStep previousWorkflowStep)

setNextEvent

WorkflowStep.WorkflowStepBuilder setNextEvent(EventInstruction nextEvent)

setMessageInformation

WorkflowStep.WorkflowStepBuilder setMessageInformation(MessageInformation messageInformation)

addTimestamp

WorkflowStep.WorkflowStepBuilder addTimestamp(EventTimestamp timestamp)

addTimestamp

WorkflowStep.WorkflowStepBuilder addTimestamp(EventTimestamp timestamp,
 int idx)

addTimestamp

WorkflowStep.WorkflowStepBuilder addTimestamp(List<? extends EventTimestamp> timestamp)

setTimestamp

WorkflowStep.WorkflowStepBuilder setTimestamp(List<? extends EventTimestamp> timestamp)

addEventIdentifier

WorkflowStep.WorkflowStepBuilder addEventIdentifier(Identifier eventIdentifier)

addEventIdentifier

WorkflowStep.WorkflowStepBuilder addEventIdentifier(Identifier eventIdentifier,
 int idx)

addEventIdentifier

WorkflowStep.WorkflowStepBuilder addEventIdentifier(List<? extends Identifier> eventIdentifier)

setEventIdentifier

WorkflowStep.WorkflowStepBuilder setEventIdentifier(List<? extends Identifier> eventIdentifier)

setAction

WorkflowStep.WorkflowStepBuilder setAction(ActionEnum action)

addParty

WorkflowStep.WorkflowStepBuilder addParty(Party party)

addParty

WorkflowStep.WorkflowStepBuilder addParty(Party party,
 int idx)

addParty

WorkflowStep.WorkflowStepBuilder addParty(List<? extends Party> party)

setParty

WorkflowStep.WorkflowStepBuilder setParty(List<? extends Party> party)

addAccount

WorkflowStep.WorkflowStepBuilder addAccount(Account account)

addAccount

WorkflowStep.WorkflowStepBuilder addAccount(Account account,
 int idx)

addAccount

WorkflowStep.WorkflowStepBuilder addAccount(List<? extends Account> account)

setAccount

WorkflowStep.WorkflowStepBuilder setAccount(List<? extends Account> account)

setLineage

WorkflowStep.WorkflowStepBuilder setLineage(Lineage lineage)

setCreditLimitInformation

WorkflowStep.WorkflowStepBuilder setCreditLimitInformation(CreditLimitInformation creditLimitInformation)

setWorkflowState

WorkflowStep.WorkflowStepBuilder setWorkflowState(WorkflowState workflowState)

setMeta

WorkflowStep.WorkflowStepBuilder setMeta(com.rosetta.model.metafields.MetaFields meta)

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.BuilderProcessor processor)

Specified by:

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

prune

WorkflowStep.WorkflowStepBuilder prune()

Specified by:

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