Package cdm.event.workflow

Interface WorkflowStep

All Superinterfaces:
com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
WorkflowStep.WorkflowStepBuilder
All Known Implementing Classes:
WorkflowStep.WorkflowStepBuilderImpl, WorkflowStep.WorkflowStepImpl
@RosettaDataType(value="WorkflowStep", builder=WorkflowStepBuilderImpl.class, version="5.30.0") @RuneDataType(value="WorkflowStep", model="cdm", builder=WorkflowStepBuilderImpl.class, version="5.30.0") public interface WorkflowStep extends com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.GlobalKey
A workflow step represents the state of a business event. The workflow step contains a reference to a previous WorkflowStep in order to preserve lineage. A workflow step is accepted if it contains a business event, proposed if proposedEvent is present and is rejected if the rejected flag is set.
Version:
5.30.0

  • Field Details

  • Method Details

    • getBusinessEvent

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

    • getCounterpartyPositionBusinessEvent

      CounterpartyPositionBusinessEvent getCounterpartyPositionBusinessEvent()
      Documents the life cycle event for a position.

    • getProposedEvent

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

    • getRejected

      Boolean getRejected()
      Flags this step as rejected.

    • getApproval

      List<? extends WorkflowStepApproval> getApproval()
      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.

    • getPreviousWorkflowStep

      ReferenceWithMetaWorkflowStep getPreviousWorkflowStep()
      Optional previous workflow step that provides lineage to workflow steps that precedes it.

    • getNextEvent

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

    • getMessageInformation

      MessageInformation getMessageInformation()
      Contains all information pertaining the FpML messaging header

    • getTimestamp

      List<? extends EventTimestamp> getTimestamp()
      The set of timestamp(s) associated with the event as a collection of [dateTime, qualifier].

    • getEventIdentifier

      List<? extends Identifier> getEventIdentifier()
      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.

    • getAction

      ActionEnum getAction()
      Specifies whether the event is a new, a correction or a cancellation.

    • getParty

      List<? extends Party> getParty()
      The specification of the event parties. This attribute is optional, as not applicable to certain events (e.g. most of the observations).

    • getAccount

      List<? extends Account> getAccount()
      Optional account information that could be associated to the event.

    • getLineage

      Lineage getLineage()
      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).

    • getCreditLimitInformation

      CreditLimitInformation getCreditLimitInformation()

    • getWorkflowState

      WorkflowState 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.

    • getMeta

      com.rosetta.model.metafields.MetaFields getMeta()
      Specified by:
      getMeta in interface com.rosetta.model.lib.GlobalKey

    • build

      WorkflowStep build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      WorkflowStep.WorkflowStepBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static WorkflowStep.WorkflowStepBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends WorkflowStep> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

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