Vision Messages: LinkRecord

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

Profile of Class LinkRecord

Includes Classes: CompositeAccount Component, Holding, LinkRecord 


Object
  | 
  +--- LinkRecord
  |      |
  |      +--- CompositeAccount Component
  |      |
  |      +--- Holding

This abstract class is used to define subclasses that symmetrically related two or more entities to other data.

Message Index

o _accountingPrice (Holding)
o _shares (Holding)
o _totalCost (Holding)
o _totalMarketValue (Holding)
o account (Holding)
o account (CompositeAccount Component)
o accountingPrice (Holding)
o addKeyOfType: type (LinkRecord)
o adjustmentFactor (Holding)
o asSelf (LinkRecord)
o asSelf (Holding)
o asSelf (CompositeAccount Component)
o classDescriptor (LinkRecord)
o classDescriptor (Holding)
o classDescriptor (CompositeAccount Component)
o cleanupClassStructures (Holding)
o compositeAccount (CompositeAccount Component)
o createInSecurity: sec andAccount: port (Holding)
o createNewStoreAsOf: date (Holding)
o createNewStoreAsOf: date at: ospace (Holding)
o currencyFactor (Holding)
o date (Holding)
o date (CompositeAccount Component)
o defaultInstance (LinkRecord)
o defaultInstance (Holding)
o defaultInstance (CompositeAccount Component)
o displayInfo (LinkRecord)
o getKeyValues (LinkRecord)
o id (Holding)
o initializeCashFrom: list (Holding)
o initializeFrom: list (Holding)
o initializeGlobalSubclassProperties (LinkRecord)
o initializeKeys: keys (LinkRecord)
o initializeKeys: keys (Holding)
o isComponent (CompositeAccount Component)
o isHolding (Holding)
o isLinkRecord (LinkRecord)
o keyList (LinkRecord)
o keyList (Holding)
o keyList (CompositeAccount Component)
o percentOfEquity (Holding)
o percentOfPort (Holding)
o print (LinkRecord)
o profile (LinkRecord)
o security (Holding)
o shares (Holding)
o storeXRef (Holding)
o totalCost (Holding)
o totalMarketValue (Holding)
o updateBlocks (LinkRecord)
o updateBlocks (Holding)
o updateBlocks (CompositeAccount Component)
o weight (CompositeAccount Component)
o whatAmI (LinkRecord)
o whatAmI (Holding)
o whatAmI (CompositeAccount Component)

Messages

o _accountingPrice

Synopsis:
Holding _accountingPrice

Description:

Actual price supplied to compute market value.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _shares

Synopsis:
Holding _shares

Description:

Actual shares held by account in security on date.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _totalCost

Synopsis:
Holding _totalCost

Description:

Cost of shares held by account in security on date (in baseCurrency of account).

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o _totalMarketValue

Synopsis:
Holding _totalMarketValue

Description:

Market value of shares held by account in security on date (in baseCurrency of account).

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o account

Synopsis:
Holding account

Description:

Account represented by holding.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Account

o account

Synopsis:
CompositeAccount Component account

Description:

Account object represented by component

Type: FixedProperty          Function: Data          Level: Basic

Returns: Account

o accountingPrice

Synopsis:
Holding accountingPrice

Description:

Price supplied to compute market value (adjusted for splits and currency override).

Type: Method          Function: Data          Level: Basic

Returns: Number

o addKeyOfType:

Synopsis:
LinkRecord addKeyOfType: type

Description:

Adds supplied object to 'keyList' and defines a fixed property for recipient's class using this object's whatAmI (initial letter is lowercase) if it does not already exist. If defined, the property will return the supplied object by default.

Type: Method          Function: Schema          Level: DBA

Returns: LinkRecord

Parameters:

1 - Object

o adjustmentFactor

Synopsis:
Holding adjustmentFactor

Description:

Split adjustment factor since date.

Type: Method          Function: Data          Level: Basic

Returns: Number

o asSelf

Synopsis:
LinkRecord asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: LinkRecord

o asSelf

Synopsis:
Holding asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Holding

o asSelf

Synopsis:
CompositeAccount Component asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: CompositeAccount Component

o classDescriptor

Synopsis:
LinkRecord classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Holding classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
CompositeAccount Component classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o cleanupClassStructures

Synopsis:
Holding cleanupClassStructures

Description:

Aligns complex structures. This method is invoked as part of a production cleanup process.

Type: Method          Function: DBAdmin          Level: DBA

Returns: NoValue

o compositeAccount

Synopsis:
CompositeAccount Component compositeAccount

Description:

CompositeAccount object represented by component

Type: FixedProperty          Function: Data          Level: Basic

Returns: CompositeAccount

o createInSecurity:andAccount:

Synopsis:
Holding createInSecurity: sec andAccount: port

Description:

Creates a new Holding and initializes 'security' and 'account' properties with supplied values.

Type: Method          Function: Update          Level: DBA

Returns: Holding

Parameters:

1 - Security
2 - Account

o createNewStoreAsOf:

Synopsis:
Holding createNewStoreAsOf: date

Description:

Creates new physical store for Holding instances and updates the 'storeXRef' time series as of supplied date with the new store.

Type: Method          Function: DBAdmin          Level: DBA

Returns: Holding

Parameters:

1 - Date

o createNewStoreAsOf:at:

Synopsis:
Holding createNewStoreAsOf: date at: ospace

Description:

Creates new physical store for Holding instances and updates the 'storeXRef' time series as of supplied date with the new store. The message 'Holding' is deifned at the supplied object to return the new store as well.

Type: Method          Function: DBAdmin          Level: DBA

Returns: Holding

Parameters:

1 - Date
2 - Object

o currencyFactor

Synopsis:
Holding currencyFactor

Description:

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

Type: Method          Function: Data          Level: Basic

Returns: Number

o date

Synopsis:
Holding date

Description:

Date represented by holding.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Date

o date

Synopsis:
CompositeAccount Component date

Description:

Date represented by component. This date corresponds to the date in the underlying CompositeAccount's componentList on which this component is a member.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Date

o defaultInstance

Synopsis:
LinkRecord defaultInstance

Description:

Returns the default LinkRecord instance.

Type: Constant          Function: Schema          Level: Basic

Returns: LinkRecord

o defaultInstance

Synopsis:
Holding defaultInstance

Description:

Returns the default Holding instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Holding

o defaultInstance

Synopsis:
CompositeAccount Component defaultInstance

Description:

Returns the default CompositeAccount Component instance.

Type: Constant          Function: Schema          Level: Basic

Returns: CompositeAccount Component

o displayInfo

Synopsis:
LinkRecord displayInfo

Description:

Displays a single line summary of the object terminated with a new line.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o getKeyValues

Synopsis:
LinkRecord getKeyValues

Description:

Returns list of values for the recipient's 'key' properties.

Type: Method          Function: Data          Level: Basic

Returns: List of Object

o id

Synopsis:
Holding id

Description:

Formatted string containing securityId---accountId.

Type: Method          Function: Format          Level: Basic

Returns: String

o initializeCashFrom:

Synopsis:
Holding initializeCashFrom: list

Description:

Updates the '_totalMarketValue', '_shares', and '_totalCost' properties in recipients using the total 'totalMarketValue' of the supplied list if non-NA, otherwise using the total 'shares' of the supplied list if non-NA, otherwise using the total 'totalCost' of the supplied list. The recipient is assumed to be a holding in a cash security and the supplied is list is assumed to respond to the 'totalMarketValue', 'shares', and 'totalCost' messages.

Type: Method          Function: Update          Level: DBA

Returns: Holding

Parameters:

1 - List

o initializeFrom:

Synopsis:
Holding initializeFrom: list

Description:

Updates the '_shares' property in recipient using the total 'shares' in supplied list, updates the '_totalMarketValue' property in recipient using the total 'totalMarketValue' in supplied list, and updates the '_totalCost' property in recipient using the total 'totalCost' in supplied list.

Type: Method          Function: Update          Level: DBA

Returns: Holding

Parameters:

1 - List

o initializeGlobalSubclassProperties

Synopsis:
LinkRecord 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: Basic

Returns: LinkRecord

o initializeKeys:

Synopsis:
LinkRecord initializeKeys: keys

Description:

This method is run as part of the 'createInstance:' process.

Type: Method          Function: Creation          Level: Basic

Returns: LinkRecord

Parameters:

1 - List

o initializeKeys:

Synopsis:
Holding initializeKeys: keys

Description:

Initializes the recpient with values supplied in parameter. Parameter should be a list containing a Security object as its first element and an Account object as its second element. These values are used to update the 'security' and 'account' properties in recipient. The recipient's 'baseCurrency' is set to the account's base currency value and the 'date' is set to the current ^date.

Type: Method          Function: Creation          Level: DBA

Returns: Holding

Parameters:

1 - List

o isComponent

Synopsis:
CompositeAccount Component isComponent

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isHolding

Synopsis:
Holding isHolding

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isLinkRecord

Synopsis:
LinkRecord isLinkRecord

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o keyList

Synopsis:
LinkRecord keyList

Description:

List of 'key' types defined for recipient's class.

Type: Constant          Function: Schema          Level: DBA

Returns: List of Object

o keyList

Synopsis:
Holding keyList

Description:

Returns the list: Security, Account, Date - the keys for the Holding class.

Type: Constant          Function: Schema          Level: DBA

Returns: List of Object

o keyList

Synopsis:
CompositeAccount Component keyList

Description:

Returns the list: CompositeAccount, Account, Date - the keys for the recipient's class.

Type: Constant          Function: Schema          Level: DBA

Returns: List of Object

o percentOfEquity

Synopsis:
Holding percentOfEquity

Description:

Percent of equity portion of account represented by recipient on recipient's 'date'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o percentOfPort

Synopsis:
Holding percentOfPort

Description:

Percent of account's market value represented by recipient on recipient's 'date'.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o print

Synopsis:
LinkRecord print

Description:

Prints the recipient's keys.

Type: Method          Function: Display          Level: Basic

Returns: LinkRecord

o profile

Synopsis:
LinkRecord profile

Description:

Displays a multi-line description of the recipient.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o security

Synopsis:
Holding security

Description:

Security represented by holding.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Security

o shares

Synopsis:
Holding shares

Description:

Shares (or unit amount) of recipient's 'security' held by recipient's 'account' on recipient's date, adjusted for splits.

Type: Method          Function: Data          Level: Basic

Returns: Number

o storeXRef

Synopsis:
Holding storeXRef

Description:

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

Type: Constant          Function: DBAdmin          Level: DBA

Returns: TimeSeries of Holding

o totalCost

Synopsis:
Holding totalCost

Description:

Cost of shares held (adjusted for currency override).

Type: Method          Function: Data          Level: Basic

Returns: Number

o totalMarketValue

Synopsis:
Holding totalMarketValue

Description:

Market value of shares held (adjusted for currency override).

Type: Method          Function: Data          Level: Basic

Returns: Number

o updateBlocks

Synopsis:
LinkRecord updateBlocks

Description:

List of blocks that can be sent to recipient to retrieve value of each key.

Type: Constant          Function: Schema          Level: DBA

Returns: List of Block

o updateBlocks

Synopsis:
Holding updateBlocks

Description:

List of blocks that can be sent to recipient to retrieve value of each key (Security, Account and Date).

Type: Constant          Function: Schema          Level: DBA

Returns: List of Block

o updateBlocks

Synopsis:
CompositeAccount Component updateBlocks

Description:

List of blocks that can be sent to recipient to retrieve value of each key (CompositeAccount, Account and Date).

Type: Constant          Function: Schema          Level: DBA

Returns: List of Block

o weight

Synopsis:
CompositeAccount Component weight

Description:

Weight to use when accessing holdings for account object represented by component

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

o whatAmI

Synopsis:
LinkRecord whatAmI

Description:

Returns the string "LinkRecord".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
Holding whatAmI

Description:

Returns the string "Holding".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
CompositeAccount Component whatAmI

Description:

Returns the string "CompositeAccount Component".

Type: Constant          Function: Schema          Level: Basic

Returns: String