Vision Messages: DataRecord

| Application Class | Message XRef | Messages (General) |

Profile of Class DataRecord

Includes Classes: DataRecord, DivRecord, PriceRecord 


Object
  | 
  +--- DataRecord
  |      |
  |      +--- DivRecord
  |      |
  |      +--- PriceRecord

This abstract class is used to define subclasses that manage subsets of data about a specific entity so that data can be organized into manageable units.

Message Index

o _ask (PriceRecord)
o _bid (PriceRecord)
o _div (DivRecord)
o _high (PriceRecord)
o _low (PriceRecord)
o _open (PriceRecord)
o _price (PriceRecord)
o _volume (PriceRecord)
o addDiv: div asOf: date inCurrency: curr for: security (DivRecord)
o adjustmentDate (DataRecord)
o adjustmentFactor (DataRecord)
o asSelf (DataRecord)
o asSelf (DivRecord)
o asSelf (PriceRecord)
o ask (PriceRecord)
o bid (PriceRecord)
o classDescriptor (DataRecord)
o classDescriptor (DivRecord)
o classDescriptor (PriceRecord)
o cleanupClassStructures (DataRecord)
o currency (DataRecord)
o currencyFactor (DataRecord)
o currentStore (DataRecord)
o currentStore (DivRecord)
o currentStore (PriceRecord)
o date (DataRecord)
o defaultInstance (DataRecord)
o defaultInstance (DivRecord)
o defaultInstance (PriceRecord)
o displayInfo (DataRecord)
o div (DivRecord)
o entity (DataRecord)
o getAllInstances (DataRecord)
o getCurrentInstances (DataRecord)
o getNewPrototype (DataRecord)
o high (PriceRecord)
o initializeGlobalSubclassProperties (DataRecord)
o initializeKeys: keys (DataRecord)
o initializeLocalAttributes (DataRecord)
o isDataRecord (DataRecord)
o isDivRecord (DivRecord)
o isPriceRecord (PriceRecord)
o low (PriceRecord)
o open (PriceRecord)
o paymentDate (DivRecord)
o price (PriceRecord)
o print (DataRecord)
o print (DivRecord)
o print (PriceRecord)
o print: format (DataRecord)
o print: format (DivRecord)
o print: format (PriceRecord)
o purgeRecordAndLink (DataRecord)
o recordDate (DataRecord)
o recordValue (DataRecord)
o security (DivRecord)
o security (PriceRecord)
o setAdjustmentDateTo: date (DataRecord)
o setAskTo: value (PriceRecord)
o setBidTo: value (PriceRecord)
o setDividendTo: div (DivRecord)
o setHighTo: value (PriceRecord)
o setLowTo: value (PriceRecord)
o setOpenTo: value (PriceRecord)
o setPaymentDateTo: date (DivRecord)
o setPriceTo: price (PriceRecord)
o setUpdateBlockTo: aBlock (DataRecord)
o setVolumeTo: vol (PriceRecord)
o storeXRef (DataRecord)
o storeXRef (DivRecord)
o storeXRef (PriceRecord)
o updateBlock (DataRecord)
o volume (PriceRecord)
o whatAmI (DataRecord)
o whatAmI (DivRecord)
o whatAmI (PriceRecord)

Messages

o _ask

Synopsis:
PriceRecord _ask

Description:

Asking price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _bid

Synopsis:
PriceRecord _bid

Description:

Bid price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _div

Synopsis:
DivRecord _div

Description:

Same as 'recordValue'. Total cash dividend paid by 'security' on 'date' in record's 'baseCurrency' unadjusted for splits since 'adjustmentDate'.

Type: Method          Function: Data          Level: Basic

Returns: Number

o _high

Synopsis:
PriceRecord _high

Description:

High price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _low

Synopsis:
PriceRecord _low

Description:

Low price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _open

Synopsis:
PriceRecord _open

Description:

Opening price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _price

Synopsis:
PriceRecord _price

Description:

Same as 'recordValue'. Closing price of 'security' on 'date' in 'baseCurrency' of recipient unadjusted for splits since 'adjustmentDate'.

Type: Method          Function: Data          Level: Basic

Returns: Number

o _volume

Synopsis:
PriceRecord _volume

Description:

Trading volume of 'security' on 'date' unadjusted for splits since 'adjustmentDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o addDiv:asOf:inCurrency:for:

Synopsis:
DivRecord addDiv: div asOf: date inCurrency: curr for: security

Description:

Adds a new DivRecord for supplied security on supplied date if needed, then refreshes its 'recordValue' and 'baseCurrency' with supplied dividend and currency.

Type: Method          Function: Update          Level: DBA

Returns: DivRecord

Parameters:

1 - Number
2 - Date
3 - Currency
4 - Security

o adjustmentDate

Synopsis:
DataRecord adjustmentDate

Description:

Date through which data in recipient is adjusted. By default, this is the same as the 'recordDate'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Date

o adjustmentFactor

Synopsis:
DataRecord adjustmentFactor

Description:

Factor to adjust data in recipient for splits that have occurred since 'adjustmentDate'. By default, this value is 1.0.

Type: Method          Function: Data          Level: Basic

Returns: Number

o asSelf

Synopsis:
DataRecord asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: DataRecord

o asSelf

Synopsis:
DivRecord asSelf

Description:

recipient object, stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: DivRecord

o asSelf

Synopsis:
PriceRecord asSelf

Description:

recipient object, stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: PriceRecord

o ask

Synopsis:
PriceRecord ask

Description:

Asking price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o bid

Synopsis:
PriceRecord bid

Description:

Bid price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o classDescriptor

Synopsis:
DataRecord classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
DivRecord classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
PriceRecord classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o cleanupClassStructures

Synopsis:
DataRecord cleanupClassStructures

Description:

Runs 'cleanStoreAndDictionary' at Object, this method is redefined as needed by subclasses to perform general cleanup functions.

Type: Method          Function: DBAdmin          Level: DBA

Returns: NoValue

o currency

Synopsis:
DataRecord currency

Description:

Currency of related entity. This is the 'baseCurrency' of the entity by default, unless a currency override is in effect.

Type: Method          Function: Data          Level: Basic

Returns: Currency

o currencyFactor

Synopsis:
DataRecord currencyFactor

Description:

Factor to convert monetary values in recpient to the current 'currency'

Type: Method          Function: Data          Level: Basic

Returns: Number

o currentStore

Synopsis:
DataRecord currentStore

Description:

Current physical store used to instatiate new instances.

Type: Constant          Function: Update          Level: DBA

Returns: DataRecord

o currentStore

Synopsis:
DivRecord currentStore

Description:

Current physical store used to instatiate new instances.

Type: Constant          Function: Update          Level: DBA

Returns: DivRecord

o currentStore

Synopsis:
PriceRecord currentStore

Description:

Current physical store used to instatiate new instances.

Type: Constant          Function: Update          Level: DBA

Returns: PriceRecord

o date

Synopsis:
DataRecord date

Description:

Date for which data in recipient applies (same as 'recordDate')

Type: Method          Function: Data          Level: Basic

Returns: Date

o defaultInstance

Synopsis:
DataRecord defaultInstance

Description:

Default DataRecord instance.

Type: Constant          Function: Schema          Level: Basic

Returns: DataRecord

o defaultInstance

Synopsis:
DivRecord defaultInstance

Description:

Default DivRecord instance.

Type: Constant          Function: Schema          Level: Basic

Returns: DivRecord

o defaultInstance

Synopsis:
PriceRecord defaultInstance

Description:

Default PriceRecord instance.

Type: Constant          Function: Schema          Level: Basic

Returns: PriceRecord

o displayInfo

Synopsis:
DataRecord displayInfo

Description:

Displays a single line summary of recipient terminated with a new line.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o div

Synopsis:
DivRecord div

Description:

Total dividends paid for security on date adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o entity

Synopsis:
DataRecord entity

Description:

Entity with which the recpient is associated.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Entity

o getAllInstances

Synopsis:
DataRecord getAllInstances

Description:

List of all instances in all stores of recipient's class.

Type: Method          Function: Access          Level: Advanced

Returns: List of DataRecord

o getCurrentInstances

Synopsis:
DataRecord getCurrentInstances

Description:

List of all instances in recipient's 'currentStore'.

Type: Method          Function: Access          Level: Advanced

Returns: List of DataRecord

o getNewPrototype

Synopsis:
DataRecord getNewPrototype

Description:

Creates new physical store for recipient's class.

Type: Method          Function: Schema          Level: DBA

Returns: DataRecord

o high

Synopsis:
PriceRecord high

Description:

High price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o initializeGlobalSubclassProperties

Synopsis:
DataRecord initializeGlobalSubclassProperties

Description:

This method is run as part of the 'specialized' method and is used to initialize properties in the default row of the new class.

Type: Method          Function: Creation          Level: DBA

Returns: DataRecord

o initializeKeys:

Synopsis:
DataRecord initializeKeys: keys

Description:

Initializes new instance with supplied key values. Up to four values should be supplied as a list: entity, date, value, and currency. These values will be used to update the 'entity', 'recordDate', 'recordValue', and 'baseCurrency' properties in the recipient.

Type: Method          Function: Creation          Level: DBA

Returns: DataRecord

Parameters:

1 - List

o initializeLocalAttributes

Synopsis:
DataRecord initializeLocalAttributes

Description:

Iniitializes new instances. This method runs the general initializations defined for all objects followed by initializations defined for the recipient's class.

Type: Method          Function: Creation          Level: DBA

Returns: DataRecord

o isDataRecord

Synopsis:
DataRecord isDataRecord

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isDivRecord

Synopsis:
DivRecord isDivRecord

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isPriceRecord

Synopsis:
PriceRecord isPriceRecord

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o low

Synopsis:
PriceRecord low

Description:

Low price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o open

Synopsis:
PriceRecord open

Description:

Opening price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o paymentDate

Synopsis:
DivRecord paymentDate

Description:

Payment date for dividend

Type: FixedProperty          Function: Data          Level: Basic

Returns: Date

o price

Synopsis:
PriceRecord price

Description:

Closing price, adjusted for splits in current currency associated with security.

Type: Method          Function: Data          Level: Basic

Returns: Number

o print

Synopsis:
DataRecord print

Description:

Prints the recipient's 'recordValue' if non-NA; otherwise, the recipient's class name is printed.

Type: Method          Function: Display          Level: Basic

Returns: DataRecord

o print

Synopsis:
DivRecord print

Description:

Prints the total dividend, by default.

Type: Method          Function: Display          Level: Basic

Returns: DivRecord

o print

Synopsis:
PriceRecord print

Description:

Prints the closing price, by default.

Type: Method          Function: Display          Level: Basic

Returns: PriceRecord

o print:

Synopsis:
DataRecord print: format

Description:

Prints recipient using supplied format.

Type: Method          Function: Display          Level: Basic

Returns: DataRecord

Parameters:

1 - Number

o print:

Synopsis:
DivRecord print: format

Description:

Prints the dividend using supplied format.

Type: Method          Function: Display          Level: Basic

Returns: DivRecord

Parameters:

1 - Number

o print:

Synopsis:
PriceRecord print: format

Description:

Prints closing price using supplied format.

Type: Method          Function: Display          Level: Basic

Returns: PriceRecord

Parameters:

1 - Number

o purgeRecordAndLink

Synopsis:
DataRecord purgeRecordAndLink

Description:

Deletes the recipient after severing its relationship with its underlying entity.

Type: Method          Function: Update          Level: DBA

Returns: NoValue

o recordDate

Synopsis:
DataRecord recordDate

Description:

Date for which data in recipient applies.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Date

o recordValue

Synopsis:
DataRecord recordValue

Description:

Property used to record 'primary' data value in record, if appropriate. This is the value that will print by default.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Object

o security

Synopsis:
DivRecord security

Description:

Same as 'entity'. Security associated with recipient.

Type: Method          Function: Data          Level: Basic

Returns: Security

o security

Synopsis:
PriceRecord security

Description:

Same as 'entity'. Security associated with recipient.

Type: Method          Function: Data          Level: Basic

Returns: Security

o setAdjustmentDateTo:

Synopsis:
DataRecord setAdjustmentDateTo: date

Description:

Updates the 'adjustmentDate' to indicate that data in the recpient has been adjusted through a date that is different from the record date.

Type: Method          Function: Update          Level: DBA

Returns: DataRecord

Parameters:

1 - Date

o setAskTo:

Synopsis:
PriceRecord setAskTo: value

Description:

Set/reset ask value in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setBidTo:

Synopsis:
PriceRecord setBidTo: value

Description:

Set/reset bid value in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setDividendTo:

Synopsis:
DivRecord setDividendTo: div

Description:

Set/reset value of dividend in recipient.

Type: Method          Function: Update          Level: DBA

Returns: DivRecord

Parameters:

1 - Number

o setHighTo:

Synopsis:
PriceRecord setHighTo: value

Description:

Set/reset high value in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setLowTo:

Synopsis:
PriceRecord setLowTo: value

Description:

Set/reset low value in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setOpenTo:

Synopsis:
PriceRecord setOpenTo: value

Description:

Set/reset open value in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setPaymentDateTo:

Synopsis:
DivRecord setPaymentDateTo: date

Description:

Set/reset value of payment date in recipient.

Type: Method          Function: Update          Level: DBA

Returns: DivRecord

Parameters:

1 - Date

o setPriceTo:

Synopsis:
PriceRecord setPriceTo: price

Description:

Set/reset closing price in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o setUpdateBlockTo:

Synopsis:
DataRecord setUpdateBlockTo: aBlock

Description:

Defines the block to use to access the property at the underlying entity's class for update.

Type: Method          Function: Schema          Level: DBA

Returns: DataRecord

Parameters:

1 - Block

o setVolumeTo:

Synopsis:
PriceRecord setVolumeTo: vol

Description:

Set/reset volume in recipient.

Type: Method          Function: Update          Level: DBA

Returns: PriceRecord

Parameters:

1 - Number

o storeXRef

Synopsis:
DataRecord storeXRef

Description:

List of physical storage structures created for recipient's class.

Type: Constant          Function: DBAdmin          Level: DBA

Returns: List of DataRecord

o storeXRef

Synopsis:
DivRecord storeXRef

Description:

List of physical storage structures created for recipient's class.

Type: Constant          Function: Schema          Level: DBA

Returns: List of DivRecord

o storeXRef

Synopsis:
PriceRecord storeXRef

Description:

List of physical storage structures created for recipient's class.

Type: Constant          Function: Schema          Level: DBA

Returns: List of PriceRecord

o updateBlock

Synopsis:
DataRecord updateBlock

Description:

Block used to access the property at the underlying entity's class for update.

Type: Constant          Function: DBAdmin          Level: DBA

Returns: Block

o volume

Synopsis:
PriceRecord volume

Description:

Volume, adjusted for splits.

Type: Method          Function: Data          Level: Basic

Returns: Number

o whatAmI

Synopsis:
DataRecord whatAmI

Description:

Returns name of recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
DivRecord whatAmI

Description:

Returns name of recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
PriceRecord whatAmI

Description:

Returns name of recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: String