Order

java.lang.Object
- stScript.process.api.Order

```
public final class Order
extends Object
```
Classe que representa uma ordem.
Essa classe é imutável, ou seja, os seus dados nunca serão alterados, se mantendo os mesmos desde o momento de sua criação.
Quando uma ordem é modificada, essa modificação deverá ser consultada através de um novo objeto Order criado com base nos dados mais recentes.

Since:

0.27.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Side` Representa a direção da ordem.
`static class`	`Order.Status` Enumera os status que uma ordem pode assumir.
`static class`	`Order.StopType` Representa o tipo da ordem stop.
`static class`	`Order.Type` Representa o tipo da ordem.
`static class`	`Order.Validity` Representa a validade da ordem.

Constructor Summary

Constructors
Constructor and Description

Order(net.sourceforge.eclipsetrader.core.db.Order source)
Restrição: Projetado para utilização interna do Tryd.

Constructors
Constructor and Description
`Order(net.sourceforge.eclipsetrader.core.db.Order source)` Restrição: Projetado para utilização interna do Tryd.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`long`	`getApparentQuantity()` Quantidade aparente.
`double`	`getAveragePrice()` Preço médio da ordem.
`Date`	`getDate()` Data da ordem.
`Date`	`getExpire()` Data em que a ordem irá expirar.
`long`	`getFilledQuantity()` Quantidade total que já foi executada até o momento.
`Date`	`getLastUpdate()` Data da última atualização da ordem até o momento.
`long`	`getMinimumQuantity()` Quantidade mínima a ser executada.
`String`	`getOrderId()` Número de controle da ordem.
`String`	`getOriginalOrderId()` Retorna o ID da ordem que originou a ordem OCO.
`double`	`getPrice()` Preço do ativo da ordem.
`long`	`getQuantity()` Quantidade enviada na ordem.
`ScriptSecurity`	`getSecurity()` Ativo da ordem.
`String`	`getSenderLogin()` Login do usuário que enviou a ordem.
`String`	`getSentOrderId()` Retorna o ID da ordem que foi enviada a partir do disparo da ordem stop do OMS.
`Order.Side`	`getSide()` Se é uma ordem de Compra ou Venda.
`Order.Status`	`getStatus()` Status da ordem até o momento.
`Order.StopType`	`getStopType()` Retorna o tipo da ordem stop.
`double`	`getTrailingAdjustment()` O ajuste da stop móvel.
`double`	`getTrailingStart()` O início do ajuste da stop móvel.
`double`	`getTrigger()` Preço de disparo da ordem stop.
`Order.Type`	`getType()` Tipo da ordem.
`Order.Validity`	`getValidityType()` Tipo de validade da ordem.
`int`	`hashCode()`
`boolean`	`isCancelable()` Indica se a ordem é ou não cancelável.
`boolean`	`isOco()` Se a ordem é OCO ou não.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Order
```
public Order(net.sourceforge.eclipsetrader.core.db.Order source)
```
    Restrição: Projetado para utilização interna do Tryd. O usuário não deve utilizar esse método.
    Permite a construção de objetos dessa classe.
    
    Parameters:
    
    source - ordem de onde os dados são consultados. Não pode ser nulo.
    
    Throws:
    
    NullPointerException - Caso o parâmetro recebido seja nulo
- Method Detail
  - getOrderId
```
public String getOrderId()
```
    Número de controle da ordem.
    
    Returns:
    
    número de controle.
  - getStatus
```
public Order.Status getStatus()
```
    Status da ordem até o momento.
    
    Returns:
    
    status da ordem.
    
    See Also:
    
    Order.Status
  - isCancelable
```
public boolean isCancelable()
```
    Indica se a ordem é ou não cancelável.
    
    Returns:
    
    se é cancelável.
    
    Since:
    
    3.0.0
  - getPrice
```
public double getPrice()
```
    Preço do ativo da ordem.
    
    Returns:
    
    preço.
  - getTrigger
```
public double getTrigger()
```
    Preço de disparo da ordem stop.
    
    Returns:
    
    preço de disparo.
    
    Since:
    
    4.2.0.001
  - getTrailingStart
```
public double getTrailingStart()
```
    O início do ajuste da stop móvel.
    
    Returns:
    
    início do ajuste da stop móvel.
    
    Since:
    
    4.2.0.001
  - getTrailingAdjustment
```
public double getTrailingAdjustment()
```
    O ajuste da stop móvel.
    
    Returns:
    
    ajuste da stop móvel.
    
    Since:
    
    4.2.0.001
  - getQuantity
```
public long getQuantity()
```
    Quantidade enviada na ordem.
    
    Returns:
    
    quantidade.
  - getFilledQuantity
```
public long getFilledQuantity()
```
    Quantidade total que já foi executada até o momento.
    
    Returns:
    
    quantidade total executada até o momento.
  - getLastUpdate
```
public Date getLastUpdate()
```
    Data da última atualização da ordem até o momento.
    
    Returns:
    
    data da última atualização. Pode ser nulo.
  - getSecurity
```
public ScriptSecurity getSecurity()
```
    Ativo da ordem.
    
    Returns:
    
    ativo.
  - getAveragePrice
```
public double getAveragePrice()
```
    Preço médio da ordem.
    
    Returns:
    
    preço médio.
  - getDate
```
public Date getDate()
```
    Data da ordem.
    
    Returns:
    
    data da ordem. Pode ser nulo.
  - getSide
```
public Order.Side getSide()
```
    Se é uma ordem de Compra ou Venda.
    
    Returns:
    
    direção da ordem.
    
    See Also:
    
    Order.Side
  - getStopType
```
public Order.StopType getStopType()
```
    Retorna o tipo da ordem stop.
    
    Returns:
    
    O tipo da ordem stop
    
    Since:
    
    4.2.0.001
  - getType
```
public Order.Type getType()
```
    Tipo da ordem.
    
    Returns:
    
    tipo.
    
    See Also:
    
    Order.Type
  - getExpire
```
public Date getExpire()
```
    Data em que a ordem irá expirar.
    
    Returns:
    
    data de expiração. Pode ser nulo.
  - getValidityType
```
public Order.Validity getValidityType()
```
    Tipo de validade da ordem.
    
    Returns:
    
    tipo de validade.
    
    See Also:
    
    Order.Validity
  - getSenderLogin
```
public String getSenderLogin()
```
    Login do usuário que enviou a ordem.
    
    Returns:
    
    login de quem enviou a ordem.
  - getMinimumQuantity
```
public long getMinimumQuantity()
```
    Quantidade mínima a ser executada.
    
    Returns:
    
    quantidade mínima.
  - getApparentQuantity
```
public long getApparentQuantity()
```
    Quantidade aparente.
    
    Returns:
    
    quantidade aparente.
  - getOriginalOrderId
```
public String getOriginalOrderId()
```
    Retorna o ID da ordem que originou a ordem OCO.
    Somente para ordens OCO.
    
    Returns:
    
    ID da ordem que originou a ordem OCO. Caso a ordem não seja OCO, retorna null.
    
    Since:
    
    6.7.2.002
  - isOco
```
public boolean isOco()
```
    Se a ordem é OCO ou não.
    
    Returns:
    
    se é OCO ou não.
    
    Since:
    
    6.7.2.002
  - getSentOrderId
```
public String getSentOrderId()
```
    Retorna o ID da ordem que foi enviada a partir do disparo da ordem stop do OMS.
    Somente para ordens stop do OMS.
    
    Returns:
    
    ID da ordem que foi enviada a partir do disparo da ordem stop do OMS. Caso a ordem não seja stop do OMS, retorna null.
    
    Since:
    
    6.7.2.002
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Order

Method Detail

getOrderId

getStatus

isCancelable

getPrice

getTrigger

getTrailingStart

getTrailingAdjustment

getQuantity

getFilledQuantity

getLastUpdate

getSecurity

getAveragePrice

getDate

getSide

getStopType

getType

getExpire

getValidityType

getSenderLogin

getMinimumQuantity

getApparentQuantity

getOriginalOrderId

isOco

getSentOrderId

equals

hashCode