OrderStatusCode (Java API for ISO 20022 - Payments business domain)

java.lang.Object
- com.tools20022.metamodel.MMCode
- - com.tools20022.repository.codeset.OrderStatusCode

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept
```
public class OrderStatusCode
extends MMCode
```
Specifies the current status of the order.
Constant fields:
- code =
- dataDictionary = GeneratedRepository.mmdataDict
- example =
  - "NEWW"
- registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
- name = "OrderStatusCode"
- definition = "Specifies the current status of the order."

Field Summary

Fields
Modifier and Type	Field and Description
`static OrderStatusCode`	`Accepted` Order is accepted and is ready for execution (execution is the moment when pricing is applied).
`static OrderStatusCode`	`AcceptedForBidding` Order has been received and is being evaluated for pricing.
`static OrderStatusCode`	`Alert` Used whenever any of the individual orders have a status that requires something to be done.
`static OrderStatusCode`	`AlreadyExecuted` Order is already executed and confirmation has been sent.
`static OrderStatusCode`	`Calculated` Order has been completed for the day (either filled or done for day).
`static OrderStatusCode`	`Cancelled` Cancelled order with or without executions.
`static OrderStatusCode`	`Cancelling` Indicates that a cancellation request has been received and the sell side is in the process of pulling any orders that were being worked.
`static OrderStatusCode`	`CashSettledOrderNotExecuted` Order is accepted and is ready for execution (execution is the moment when pricing is applied).
`static OrderStatusCode`	`CommunicationProblemNextParty` Communication problems with the next party.
`static OrderStatusCode`	`Completed` Request for cancellation instruction for the order has been accepted and processed; the order has been cancelled.
`static OrderStatusCode`	`ConfirmationAmendment` Order confirmation cancellation has been sent and will be followed by a confirmation amendment, or a confirmation amendment has been sent.
`static OrderStatusCode`	`DoneForDay` Order has been partially filled, and is done for the day, ie, no further executions will take place today.
`static OrderStatusCode`	`Executing` Indicates that a list has been received and the sell side is working it.
`static OrderStatusCode`	`Expired` Order has been cancelled in the broker's system due to time in force instructions.
`static OrderStatusCode`	`Filled` Order completely filled, no remaining quantity.
`static OrderStatusCode`	`InvalidAgentConfirmation` Order confirmation received from agent is invalid.
`static OrderStatusCode`	`New` Outstanding order with no executions.
`static OrderStatusCode`	`Open` Order is open.
`static OrderStatusCode`	`PartialFill` Outstanding order with executions and remaining quantity.
`static OrderStatusCode`	`PartiallyDone` Order has been partially filled and will not be filled further.
`static OrderStatusCode`	`PendingCancel` Order with an Order Cancel Request pending, used to confirm receipt of an Order Cancel Request.
`static OrderStatusCode`	`PendingNew` Order has been received by sell-side system but not yet accepted for execution.
`static OrderStatusCode`	`PendingReplace` Order with an Order Cancel/Replace Request pending, used to confirm receipt of an Order Cancel/Replace Request.
`static OrderStatusCode`	`Received` Order has been received, ie, technical validation of the message is ok, and the message is now at the receiving side.
`static OrderStatusCode`	`Rejected` Order has been rejected by sell-side.
`static OrderStatusCode`	`Replaced` Order has been replaced.
`static OrderStatusCode`	`SentToNextParty` Order has been sent to the next party, eg, the next intermediary.
`static OrderStatusCode`	`Settled` Order is settled.
`static OrderStatusCode`	`Stopped` Order has been stopped at the exchange.
`static OrderStatusCode`	`Suspended` Order has been placed in suspended state at the request of the client.

Fields inherited from class com.tools20022.metamodel.MMCode
codeNameAttribute, ownerAttribute

Fields inherited from interface com.tools20022.metamodel.MMRepositoryConcept
checkNameFirstLetterUppercase, checkRemovalDateRegistrationStatus, constraintAttribute, definitionAttribute, docletAttribute, exampleAttribute, nameAttribute, registrationStatusAttribute, removalDateAttribute, semanticMarkupAttribute

Fields inherited from interface com.tools20022.metamodel.MMModelEntity
nextVersionsAttribute, objectIdentifierAttribute, previousVersionAttribute

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static MMCodeSet`	`mmObject()`
`static OrderStatusCode`	`valueOf(String codeName)`
`static OrderStatusCode[]`	`values()`

Methods inherited from class com.tools20022.metamodel.MMCode
getCodeName, getConstraint, getContainer, getDefinition, getDoclet, getExample, getMetamodel, getName, getNextVersions, getObjectIdentifier, getOwner, getPreviousVersion, getRegistrationStatus, getRemovalDate, getSemanticMarkup, metaType

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - New
```
public static final OrderStatusCode New
```
    Outstanding order with no executions.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "NEWW"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "New"
    - definition = "Outstanding order with no executions."
  - PartialFill
```
public static final OrderStatusCode PartialFill
```
    Outstanding order with executions and remaining quantity.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "PARF"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "PartialFill"
    - definition = "Outstanding order with executions and remaining quantity."
  - Filled
```
public static final OrderStatusCode Filled
```
    Order completely filled, no remaining quantity.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "FILL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Filled"
    - definition = "Order completely filled, no remaining quantity."
  - DoneForDay
```
public static final OrderStatusCode DoneForDay
```
    Order has been partially filled, and is done for the day, ie, no further executions will take place today.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "DONE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "DoneForDay"
    - definition = "Order has been partially filled, and is done for the day, ie, no further executions will take place today."
  - Cancelled
```
public static final OrderStatusCode Cancelled
```
    Cancelled order with or without executions.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CANC"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Cancelled"
    - definition = "Cancelled order with or without executions."
  - Replaced
```
public static final OrderStatusCode Replaced
```
    Order has been replaced.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "REPL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Replaced"
    - definition = "Order has been replaced."
  - PendingCancel
```
public static final OrderStatusCode PendingCancel
```
    Order with an Order Cancel Request pending, used to confirm receipt of an Order Cancel Request. Does not indicate that the order has been cancelled.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CANP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "PendingCancel"
    - definition = "Order with an Order Cancel Request pending, used to confirm receipt of an Order Cancel Request. Does not indicate that the order has been cancelled."
  - Stopped
```
public static final OrderStatusCode Stopped
```
    Order has been stopped at the exchange. Used when guaranteeing or protecting a price and quantity.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "STOP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Stopped"
    - definition = "Order has been stopped at the exchange. Used when guaranteeing or protecting a price and quantity."
  - Rejected
```
public static final OrderStatusCode Rejected
```
    Order has been rejected by sell-side. NOTE: An order can be rejected subsequent to order acknowledgment, i.e. an order can pass from New to Rejected status.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "REJT"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Rejected"
    - definition = "Order has been rejected by sell-side. NOTE: An order can be rejected subsequent to order acknowledgment, i.e. an order can pass from New to Rejected status."
  - Suspended
```
public static final OrderStatusCode Suspended
```
    Order has been placed in suspended state at the request of the client.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "SUSP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Suspended"
    - definition = "Order has been placed in suspended state at the request of the client."
  - PendingNew
```
public static final OrderStatusCode PendingNew
```
    Order has been received by sell-side system but not yet accepted for execution. An execution message with this status will only be sent in response to a Status Request message.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "PENN"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "PendingNew"
    - definition = "Order has been received by sell-side system but not yet accepted for execution. An execution message with this status will only be sent in response to a Status Request message."
  - Calculated
```
public static final OrderStatusCode Calculated
```
    Order has been completed for the day (either filled or done for day). Commission or currency settlement details have been calculated and reported in this execution message.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CALC"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Calculated"
    - definition = "Order has been completed for the day (either filled or done for day). Commission or currency settlement details have been calculated and reported in this execution message."
  - Expired
```
public static final OrderStatusCode Expired
```
    Order has been cancelled in the broker's system due to time in force instructions.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "EXPI"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Expired"
    - definition = "Order has been cancelled in the broker's system due to time in force instructions."
  - AcceptedForBidding
```
public static final OrderStatusCode AcceptedForBidding
```
    Order has been received and is being evaluated for pricing.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "ACBI"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "AcceptedForBidding"
    - definition = "Order has been received and is being evaluated for pricing."
  - PendingReplace
```
public static final OrderStatusCode PendingReplace
```
    Order with an Order Cancel/Replace Request pending, used to confirm receipt of an Order Cancel/Replace Request. Does not indicate that the order has been replaced.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "PENR"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "PendingReplace"
    - definition = "Order with an Order Cancel/Replace Request pending, used to confirm receipt of an Order Cancel/Replace Request. Does not indicate that the order has been replaced."
  - Completed
```
public static final OrderStatusCode Completed
```
    Request for cancellation instruction for the order has been accepted and processed; the order has been cancelled.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CAND"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Completed"
    - definition = "Request for cancellation instruction for the order has been accepted and processed; the order has been cancelled."
  - Accepted
```
public static final OrderStatusCode Accepted
```
    Order is accepted and is ready for execution (execution is the moment when pricing is applied).
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "PACK"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Accepted"
    - definition = "Order is accepted and is ready for execution (execution is the moment when pricing is applied)."
  - AlreadyExecuted
```
public static final OrderStatusCode AlreadyExecuted
```
    Order is already executed and confirmation has been sent.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "COSE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "AlreadyExecuted"
    - definition = "Order is already executed and confirmation has been sent."
  - SentToNextParty
```
public static final OrderStatusCode SentToNextParty
```
    Order has been sent to the next party, eg, the next intermediary.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "STNP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "SentToNextParty"
    - definition = "Order has been sent to the next party, eg, the next intermediary."
  - Received
```
public static final OrderStatusCode Received
```
    Order has been received, ie, technical validation of the message is ok, and the message is now at the receiving side.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "RECE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Received"
    - definition = "Order has been received, ie, technical validation of the message is ok, and the message is now at the receiving side."
  - Settled
```
public static final OrderStatusCode Settled
```
    Order is settled. The cash is credited or debited.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "SETT"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Settled"
    - definition = "Order is settled. The cash is credited or debited."
  - CommunicationProblemNextParty
```
public static final OrderStatusCode CommunicationProblemNextParty
```
    Communication problems with the next party.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CPNP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CommunicationProblemNextParty"
    - definition = "Communication problems with the next party."
  - ConfirmationAmendment
```
public static final OrderStatusCode ConfirmationAmendment
```
    Order confirmation cancellation has been sent and will be followed by a confirmation amendment, or a confirmation amendment has been sent.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CNFC"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "ConfirmationAmendment"
    - definition = "Order confirmation cancellation has been sent and will be followed by a confirmation amendment, or a confirmation amendment has been sent."
  - PartiallyDone
```
public static final OrderStatusCode PartiallyDone
```
    Order has been partially filled and will not be filled further.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "DONF"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "PartiallyDone"
    - definition = "Order has been partially filled and will not be filled further."
  - Open
```
public static final OrderStatusCode Open
```
    Order is open.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "OPOD"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Open"
    - definition = "Order is open."
  - InvalidAgentConfirmation
```
public static final OrderStatusCode InvalidAgentConfirmation
```
    Order confirmation received from agent is invalid.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "IACO"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "InvalidAgentConfirmation"
    - definition = "Order confirmation received from agent is invalid."
  - CashSettledOrderNotExecuted
```
public static final OrderStatusCode CashSettledOrderNotExecuted
```
    Order is accepted and is ready for execution (execution is the moment when pricing is applied). Cash is settled, but the order is not executed.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CSNE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CashSettledOrderNotExecuted"
    - definition = "Order is accepted and is ready for execution (execution is the moment when pricing is applied). Cash is settled, but the order is not executed."
  - Executing
```
public static final OrderStatusCode Executing
```
    Indicates that a list has been received and the sell side is working it.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "EXEC"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Executing"
    - definition = "Indicates that a list has been received and the sell side is working it."
  - Cancelling
```
public static final OrderStatusCode Cancelling
```
    Indicates that a cancellation request has been received and the sell side is in the process of pulling any orders that were being worked. The status of individual order can be found out from the detail repeating group.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "CACE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Cancelling"
    - definition = "Indicates that a cancellation request has been received and the sell side is in the process of pulling any orders that were being worked. The status of individual order can be found out from the detail repeating group."
  - Alert
```
public static final OrderStatusCode Alert
```
    Used whenever any of the individual orders have a status that requires something to be done. For instance, an alert would be used when a buy-side firm has submitted a list that has individual stock reject that have not been addressed.
    Constant fields:
    - owner = OrderStatusCode
    - codeName = "ALER"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Alert"
    - definition = "Used whenever any of the individual orders have a status that requires something to be done. For instance, an alert would be used when a buy-side firm has submitted a list that has individual stock reject that have not been addressed."
- Method Detail
  - mmObject
```
public static final MMCodeSet mmObject()
```
  - valueOf
```
public static OrderStatusCode valueOf(String codeName)
```
  - values
```
public static OrderStatusCode[] values()
```

Class OrderStatusCode

Field Summary

Fields inherited from class com.tools20022.metamodel.MMCode

Fields inherited from interface com.tools20022.metamodel.MMRepositoryConcept

Fields inherited from interface com.tools20022.metamodel.MMModelEntity

Method Summary

Methods inherited from class com.tools20022.metamodel.MMCode

Methods inherited from class java.lang.Object

Field Detail

New

PartialFill

Filled

DoneForDay

Cancelled

Replaced

PendingCancel

Stopped

Rejected

Suspended

PendingNew

Calculated

Expired

AcceptedForBidding

PendingReplace

Completed

Accepted

AlreadyExecuted

SentToNextParty

Received

Settled

CommunicationProblemNextParty

ConfirmationAmendment

PartiallyDone

Open

InvalidAgentConfirmation

CashSettledOrderNotExecuted

Executing

Cancelling

Alert

Method Detail

mmObject

valueOf

values