com.tools20022.repository.catalogue.msgdef.setr

Class OrderCancellationStatusReportV03

java.lang.Object

com.tools20022.metamodel.MMMessageDefinition

com.tools20022.repository.catalogue.msgdef.setr.OrderCancellationStatusReportV03

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept, MMRepositoryType

public class OrderCancellationStatusReportV03
extends MMMessageDefinition

Scope
An executing party, for example, a transfer agent, sends the OrderCancellationStatusReport to the instructing party, for example, an investment manager or its authorised representative, to report the status of an order cancellation request that was previously received.
Usage
The OrderCancellationStatusReport message is used to provide the status of:
- one or more individual order cancellation requests by using IndividualCancellationStatusReport, or,
- an order cancellation request message by using CancellationStatusReport.
If the OrderCancellationStatusReport message is used to report the status of an individual order cancellation request, then the repetitive IndividualCancellationStatusReport sequence is used and the order reference of the individual order is quoted in OrderReference. The message identification of the message in which the individual order was conveyed may also be quoted in RelatedReference.
If the OrderCancellationStatusReport message is used to report the status of an entire order cancellation request message, for example, the SubscriptionBulkOrderCancellationRequest, or a SubscriptionOrderCancellationRequest containing several orders, then the CancellationStatusReport sequence. is used and the message identification of the order cancellation request message is quoted in RelatedReference. All the order cancellation requests within the message must have the same status.
One of the following statuses can be reported:
- the order cancellation is pending, or,
- the order cancellation request is rejected, or,
- the order is cancelled.
When the cancellation is rejected, the reason for the rejection must be specified.

Constant fields:

• xmlTag = "OrdrCxlStsRptV03"
• rootElement = "Document"
• businessArea = SecuritiesTradePreviousVersion
• xors =
  • RelatedReferenceOrOtherReferenceRule
  • CancellationOrIndividualCancellationStatusReportRule
• messageSet =
  • InvestmentFundsISOPreviousversion
• messageBuildingBlock =
  • MessageIdentification
  • RelatedReference
  • OtherReference
  • CancellationStatusReport
  • IndividualCancellationStatusReport
  • Extension
• messageDefinitionIdentifier = identifier

Field Summary

Fields

Modifier and Type	Field and Description
MMXor	CancellationOrIndividualCancellationStatusReportRule Either CancellationStatusReport or at least one occurrence of IndividualCancellationStatusReport must be present, but not both.
MMMessageBuildingBlock	CancellationStatusReport Status report details of a bulk or multiple or switch order cancellation message.
MMMessageBuildingBlock	Extension Additional information that cannot be captured in the structured elements and/or any other specific block.
MMMessageDefinitionIdentifier	identifier An instance of MessageDefinitionIdentifier.
MMMessageBuildingBlock	IndividualCancellationStatusReport Status report details of one or more individual orders from a bulk or multiple or switch order cancellation request.
MMMessageBuildingBlock	MessageIdentification Reference that uniquely identifies a message from a business application standpoint.
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 Occurrences of either RelatedReference or OtherReference may be present, but not occurrences of both.

Method Summary

Modifier and Type	Method and Description
static OrderCancellationStatusReportV03	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

RelatedReferenceOrOtherReferenceRule

public final MMXor RelatedReferenceOrOtherReferenceRule

Occurrences of either RelatedReference or OtherReference may be present, but not occurrences of both.

Constant fields:

• impactedMessageBuildingBlocks =
  • RelatedReference
  • OtherReference
• messageDefinition = OrderCancellationStatusReportV03

CancellationOrIndividualCancellationStatusReportRule

public final MMXor CancellationOrIndividualCancellationStatusReportRule

Either CancellationStatusReport or at least one occurrence of IndividualCancellationStatusReport must be present, but not both.

Constant fields:

• impactedMessageBuildingBlocks =
  • CancellationStatusReport
  • IndividualCancellationStatusReport
• messageDefinition = OrderCancellationStatusReportV03

MessageIdentification

public final MMMessageBuildingBlock MessageIdentification

Reference that uniquely identifies a message from a business application standpoint.

Constant fields:

• complexType = MessageIdentification1
• xmlTag = "MsgId"
• minOccurs = 1
• maxOccurs = 1

RelatedReference

public final MMMessageBuildingBlock RelatedReference

Reference to a linked message that was previously received.

Constant fields:

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

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 = 0
• maxOccurs = 2

CancellationStatusReport

public final MMMessageBuildingBlock CancellationStatusReport

Status report details of a bulk or multiple or switch order cancellation message.

Constant fields:

• complexType = OrderStatusAndReason8
• xmlTag = "CxlStsRpt"
• minOccurs = 1
• maxOccurs = 1

IndividualCancellationStatusReport

public final MMMessageBuildingBlock IndividualCancellationStatusReport

Status report details of one or more individual orders from a bulk or multiple or switch order cancellation request.

Constant fields:

• complexType = IndividualOrderStatusAndReason4
• xmlTag = "IndvCxlStsRpt"
• minOccurs = 1

Extension

public final MMMessageBuildingBlock Extension

Additional information that cannot be captured in the structured elements and/or any other specific block.

Constant fields:

• complexType = Extension1
• xmlTag = "Xtnsn"
• minOccurs = 0

identifier

public final MMMessageDefinitionIdentifier identifier

An instance of MessageDefinitionIdentifier.

Constant fields:

• version = "03"
• businessArea = "setr"
• flavour = "001"
• messageFunctionality = "017"

Method Detail

repoType

public static OrderCancellationStatusReportV03 repoType()