com.tools20022.repository.catalogue.msgdef.setr

Class OrderInstructionStatusReportV02

java.lang.Object

com.tools20022.metamodel.MMMessageDefinition

com.tools20022.repository.catalogue.msgdef.setr.OrderInstructionStatusReportV02

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept, MMRepositoryType

public class OrderInstructionStatusReportV02
extends MMMessageDefinition

Scope
The OrderInstructionStatusReport is sent by an executing party, eg, a transfer agent, to an instructing party, eg, an investment manager or its authorised representative. There may be one or more intermediary parties between the executing party and the instructing party. The intermediary party is, for example, an intermediary or a concentrator.
This message reports the status of an order from the time the executing party receives the order until the order is executed.
Usage
The OrderInstructionStatusReport message is sent by an executing party to the instructing party to report on the status of a subscription, redemption or a switch order.
The message can be used to report one of the following:
- a received status, or
- an accepted status, or
- a sent to next party status, or
- an already executed status, or
- a cancelled status, or
- a conditionally accepted status, or
- a rejected status, or
- a suspended status, or
- an in-repair status (at the individual order level only), or
- repaired conditions (at the individual order level only).
For subscription and redemption orders, the OrderInstructionStatusReport message covers both bulk and multiple categories of orders, and this message may provide the status either at the bulk or at the individual level.
For a switch order, this message provides the status of the whole order, ie, it is not possible to accept one leg and to reject the other leg, the entire switch order has to be rejected. In order to identify which leg within the switch is causing a problem, the redemption or subscription leg identification is used.

Constant fields:

• xmlTag = "setr.016.001.02"
• rootElement = "Document"
• businessArea = SecuritiesTradeArchive
• xmlName = "setr.016.001.02"
• xors =
  • OrderDetailsOrIndividualOrderDetailsRule
  • RelatedReferenceOrOtherReferenceRule
• messageSet =
  • ISOArchive
• messageBuildingBlock =
  • OtherReference
  • RelatedReference
  • MasterReference
  • OrderDetailsReport
  • IndividualOrderDetailsReport
• messageDefinitionIdentifier = identifier

Field Summary

Fields

Modifier and Type	Field and Description
MMMessageDefinitionIdentifier	identifier An instance of MessageDefinitionIdentifier.
MMMessageBuildingBlock	IndividualOrderDetailsReport Status report details of the individual orders of a bulk or multiple order that was previously received.
MMMessageBuildingBlock	MasterReference Reference to a multiple order or bulk order that represents the common reference of several individual orders.
MMXor	OrderDetailsOrIndividualOrderDetailsRule If OrderDetailsReport is present, then no occurrence of IndividualOrderDetailsReport is allowed.
MMMessageBuildingBlock	OrderDetailsReport Status report details of a bulk or multiple or switch order that was previously received.
MMMessageBuildingBlock	OtherReference Reference to a linked message sent in a proprietary way or reference of a system.
MMMessageBuildingBlock	RelatedReference Reference to a linked message that was previously received.
MMXor	RelatedReferenceOrOtherReferenceRule At least one occurrence of either RelatedReference or OtherReference must be present, but not both.

Method Summary

Modifier and Type	Method and Description
static OrderInstructionStatusReportV02	repoType()

Methods inherited from class com.tools20022.metamodel.MMMessageDefinition

getBusinessArea, getChoreography, getConstraint, getContainer, getDefinition, getDerivation, getDoclet, getExample, getMessageBuildingBlock, getMessageDefinitionIdentifier, getMessageSet, getMetamodel, getName, getNextVersions, getObjectIdentifier, getPreviousVersion, getRegistrationStatus, getRemovalDate, getRootElement, getSemanticMarkup, getTrace, getXmlName, getXmlTag, getXors, metaType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OrderDetailsOrIndividualOrderDetailsRule

public final MMXor OrderDetailsOrIndividualOrderDetailsRule

If OrderDetailsReport is present, then no occurrence of IndividualOrderDetailsReport is allowed. If OrderDetailsReport is not present, then at least one occurrence of IndividualOrderDetailsReport must be present.

Constant fields:

• impactedMessageBuildingBlocks =
  • OrderDetailsReport
  • IndividualOrderDetailsReport
• messageDefinition = OrderInstructionStatusReportV02

RelatedReferenceOrOtherReferenceRule

public final MMXor RelatedReferenceOrOtherReferenceRule

At least one occurrence of either RelatedReference or OtherReference must be present, but not both.

Constant fields:

• impactedMessageBuildingBlocks =
  • OtherReference
  • RelatedReference
• messageDefinition = OrderInstructionStatusReportV02

OtherReference

public final MMMessageBuildingBlock OtherReference

Reference to a linked message sent in a proprietary way or reference of a system.

Constant fields:

• complexType = AdditionalReference3
• xmlTag = "OthrRef"
• minOccurs = 1
• maxOccurs = 2

RelatedReference

public final MMMessageBuildingBlock RelatedReference

Reference to a linked message that was previously received.

Constant fields:

• complexType = AdditionalReference3
• xmlTag = "RltdRef"
• minOccurs = 1
• maxOccurs = 2

MasterReference

public final MMMessageBuildingBlock MasterReference

Reference to a multiple order or bulk order that represents the common reference of several individual orders.

Constant fields:

• complexType = AdditionalReference3
• xmlTag = "MstrRef"
• minOccurs = 0
• maxOccurs = 1

OrderDetailsReport

public final MMMessageBuildingBlock OrderDetailsReport

Status report details of a bulk or multiple or switch order that was previously received.

Constant fields:

• complexType = OrderStatusAndReason3
• xmlTag = "OrdrDtlsRpt"
• minOccurs = 1
• maxOccurs = 1

IndividualOrderDetailsReport

public final MMMessageBuildingBlock IndividualOrderDetailsReport

Status report details of the individual orders of a bulk or multiple order that was previously received.

Constant fields:

• complexType = IndividualOrderStatusAndReason1
• xmlTag = "IndvOrdrDtlsRpt"
• minOccurs = 1

identifier

public final MMMessageDefinitionIdentifier identifier

An instance of MessageDefinitionIdentifier.

Constant fields:

• version = "02"
• businessArea = "setr"
• flavour = "001"
• messageFunctionality = "016"

Method Detail

repoType

public static OrderInstructionStatusReportV02 repoType()