com.tools20022.repository.catalogue.msgdef.setr

Class SubscriptionOrderCancellationRequestV03

java.lang.Object

com.tools20022.metamodel.MMMessageDefinition

com.tools20022.repository.catalogue.msgdef.setr.SubscriptionOrderCancellationRequestV03

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept, MMRepositoryType

public class SubscriptionOrderCancellationRequestV03
extends MMMessageDefinition

Scope
An instructing party, for example, an investment manager or its authorised representative, sends the SubscriptionOrderCancellationRequest message to the executing party, for example, a transfer agent, to request the cancellation of a previously sent SubscriptionOrder.
Usage
The SubscriptionOrderCancellationRequest message is used to either:
- request the cancellation of an entire SubscriptionOrder message, that is, all the individual orders that it contained, or,
- request the cancellation of one or more individual orders.
There is no amendment, but a cancellation and re-instruct policy.
There are two ways to use the message:
(1) When the SubscriptionOrderCancellationRequest message is used to request the cancellation of an entire SubscriptionOrder message, this can be done by either:
- quoting the order references of all the individual orders listed in the SubscriptionOrder message, or,
- quoting the details of all the individual orders (this includes the OrderReference) listed in SubscriptionOrder message, but this is not recommended.
The message identification of the SubscriptionOrder message may also be quoted in PreviousReference.
It is also possible to request the cancellation of an entire SubscriptionOrder message by quoting its message identification in PreviousReference, but this is not recommended.
(2) When the SubscriptionOrderCancellationRequest message is used to request the cancellation of one or more individual orders, this can be done by either:
- quoting the OrderReference of each individual order listed in the SubscriptionOrder message, or,
- quoting the details of each individual order (including the OrderReference) listed in SubscriptionOrder message, but this is not recommended.
The message identification of the SubscriptionOrder message in which the individual order was conveyed may also be quoted in PreviousReference.
The deadline and acceptance of a cancellation request is subject to a service level agreement (SLA). This cancellation message is a cancellation request. There is no automatic acceptance of the cancellation.
The rejection or acceptance of a SubscriptionOrderCancellationRequest is made using an OrderCancellationStatusReport message.

Constant fields:

• xmlTag = "SbcptOrdrCxlReqV03"
• rootElement = "Document"
• businessArea = SecuritiesTradePreviousVersion
• xors =
  • CancellationByReferenceOrByOrderDetailsRule
• messageSet =
  • InvestmentFundsISOPreviousversion
• messageBuildingBlock =
  • MessageIdentification
  • PoolReference
  • PreviousReference
  • CancellationByReference
  • CancellationByOrderDetails
  • CopyDetails
• messageDefinitionIdentifier = identifier

Field Summary

Fields

Modifier and Type	Field and Description
MMMessageBuildingBlock	CancellationByOrderDetails Common information related to all the orders to be cancelled.
MMMessageBuildingBlock	CancellationByReference References of the orders to be cancelled.
MMXor	CancellationByReferenceOrByOrderDetailsRule Either CancellationByOrderDetails or CancellationByReference may be present, but not both.
MMMessageBuildingBlock	CopyDetails Message is a copy.
MMMessageDefinitionIdentifier	identifier An instance of MessageDefinitionIdentifier.
MMMessageBuildingBlock	MessageIdentification Reference that uniquely identifies a message from a business application standpoint.
MMMessageBuildingBlock	PoolReference Collective reference identifying a set of messages.
MMMessageBuildingBlock	PreviousReference Reference to a linked message that was previously sent.

Method Summary

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

CancellationByReferenceOrByOrderDetailsRule

public final MMXor CancellationByReferenceOrByOrderDetailsRule

Either CancellationByOrderDetails or CancellationByReference may be present, but not both.

Constant fields:

• impactedMessageBuildingBlocks =
  • CancellationByReference
  • CancellationByOrderDetails
• messageDefinition = SubscriptionOrderCancellationRequestV03

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

PoolReference

public final MMMessageBuildingBlock PoolReference

Collective reference identifying a set of messages.

Constant fields:

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

PreviousReference

public final MMMessageBuildingBlock PreviousReference

Reference to a linked message that was previously sent.

Constant fields:

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

CancellationByReference

public final MMMessageBuildingBlock CancellationByReference

References of the orders to be cancelled.

Constant fields:

• complexType = InvestmentFundOrder1
• xmlTag = "CxlByRef"
• minOccurs = 0
• maxOccurs = 1

CancellationByOrderDetails

public final MMMessageBuildingBlock CancellationByOrderDetails

Common information related to all the orders to be cancelled.

Constant fields:

• complexType = SubscriptionMultipleOrderInstruction2
• xmlTag = "CxlByOrdrDtls"
• minOccurs = 0
• maxOccurs = 1

CopyDetails

public final MMMessageBuildingBlock CopyDetails

Message is a copy.

Constant fields:

• complexType = CopyInformation2
• xmlTag = "CpyDtls"
• minOccurs = 0
• maxOccurs = 1

identifier

public final MMMessageDefinitionIdentifier identifier

An instance of MessageDefinitionIdentifier.

Constant fields:

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

Method Detail

repoType

public static SubscriptionOrderCancellationRequestV03 repoType()