OOTypeDescription Property
A description of the open order type.
Syntax
invstatement.getOOTypeDescription(index, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getOOTypeDescription([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setOOTypeDescription([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
A description of the open order type. This is a string representation of the value returned by the OOType property.
The types and their meanings are as follows:
ootOOBUYDEBT (0) | Buy Debt |
ootOOBUYMF (1) | Buy Mutual Fund |
ootOOBUYOPT (2) | Buy Option |
ootOOBUYOTHER (3) | Buy Other |
ootOOBUYSTOCK (4) | Buy Stock |
ootOOSELLDEBT (5) | Sell Debt |
ootOOSELLMF (6) | Sell Mutual Fund |
ootOOSELLOPT (7) | Sell Option |
ootOOSELLOTHER (8) | Sell Other |
ootOOSELLSTOCK (9) | Sell Stock |
ootSWITCHMF (10) | Switch to Mutual Fund |
ootOTHER (255) | Other |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.
This property is read-only and not available at design time.
Data Type
String