Vision Messages: Account

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

Profile of Class Account

Includes Classes: Account, AggAccount, CompositeAccount, Entity, IndexAccount, Portfolio


Object
  | 
Entity
  | 
  +--- Account
  |      |
  |      +--- AggAccount
  |      |
  |      +--- CompositeAccount
  |      |
  |      +--- IndexAccount
  |      |
  |      +--- Portfolio

This class represents actual and derived investment accounts. The subclasses of Account are used to define different styles of Account holding derivation. Applications that are independent of the holdings creation process are defined at this class so that instances of the different subclasses can be used interchangeably.

Message Index

Messages

Component

Synopsis:
CompositeAccount Component

Description:
Returns default instance of class used to instantiate components for a composite.

Type: Constant Function: Schema Level: DBA
Returns: CompositeAccount Component

XRef

Synopsis:
Entity XRef

Type: Constant Function: Not Defined Level: Basic
Returns: XRef

_totalCost

Synopsis:
Account _totalCost

Description:
Total cost of holdings in account (in its base currency).

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Number

_totalMarketValue

Synopsis:
Account _totalMarketValue

Description:
Total market value of account (in its base currency).

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Number

_totalMarketValueCash

Synopsis:
Account _totalMarketValueCash

Description:
Total cash available in account (in its base currency).

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Number

_totalMarketValueEquity

Synopsis:
Account _totalMarketValueEquity

Description:
Total market value of equity portion of account (in its base currency).

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Number

_totalMarketValueFixed

Synopsis:
Account _totalMarketValueFixed

Description:
Total market value of fixed income portion of account (in its base currency).

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Number

accessExpression

Synopsis:
Entity accessExpression

Description:
Returns a string that could be used to request recipient

Type: Method Function: Format Level: Advanced
Returns: String

addAlias:

Synopsis:
Entity addAlias: string

Description:
Adds supplied string as alternate name in recipient's naming dictionary.

Type: Method Function: Update Level: Basic
Returns: Entity
Parameters:
1 - String

addAlias:toXRefIn:

Synopsis:
Entity addAlias: string toXRefIn: dictionary

Type: Method Function: Not Defined Level: Basic
Returns: Object

addComponent:withWeight:

Synopsis:
CompositeAccount addComponent: account withWeight: weight

Description:
Creates a new instance of Component and adds it to recipient's 'componentList' as of current evaluation date using the supplied account as the index. The properties 'account' and 'weight' in the new component are set to the supplied values. Weights should be supplied as a percent.

Type: Method (time varying) Function: Update Level: DBA
Returns: CompositeAccount
Parameters:
1 - Account
2 - Number

addMember:

Synopsis:
IndexAccount addMember: security

Description:
Add supplied security to 'memberList' defined as of current evaluation date.

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - Security

aggregateList

Synopsis:
Portfolio aggregateList

Description:
List of AggAccounts that include recipient.

Type: Method (time varying) Function: Data Level: Basic
Returns: List of AggAccount
Parameters:
1 - AggAccount

aliases

Synopsis:
Entity aliases

Description:
Returns list of aliases named for entity.

Type: FixedProperty Function: Data Level: Basic
Returns: List of String

asSelf

Synopsis:
Entity asSelf

Description:
Returns the original object.

Type: Primitive Function: Conversion Level: Basic
Returns: Entity

asSelf

Synopsis:
Account asSelf

Description:
recipient object, stripped of any extensions.

Type: Primitive Function: Conversion Level: Basic
Returns: Object

asSelf

Synopsis:
Portfolio asSelf

Description:
Recipient stripped of any extensions.

Type: Primitive Function: Conversion Level: Basic
Returns: Portfolio

asSelf

Synopsis:
AggAccount asSelf

Description:
Recipient stripped of any extensions.

Type: Primitive Function: Conversion Level: Basic
Returns: AggAccount

asSelf

Synopsis:
IndexAccount asSelf

Description:
Recipient stripped of any extensions.

Type: Primitive Function: Conversion Level: Basic
Returns: IndexAccount

asSelf

Synopsis:
CompositeAccount asSelf

Description:
Recipient stripped of any extensions.

Type: Primitive Function: Conversion Level: Basic
Returns: CompositeAccount

buildHoldings

Synopsis:
AggAccount buildHoldings

Description:
Creates holdings from the holdings associated with the Portfolios in recipient's memberList as of the evalution date.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

buildHoldings

Synopsis:
CompositeAccount buildHoldings

Description:
Creates holdings from the holdings associated with the accounts in recipient's 'componentList' as of the evalution date. The shares and market values are computed using the weight stored for the component. For example, if Account XYZ is a component with a weight of 50, 50% of each holding in Account XYZ will be included in the rcipient. Note that the weights are used to determine the number of shares and market value for each holding and need not add up to 100.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

classDescriptor

Synopsis:
Entity classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Function: Schema Level: Basic
Returns: Object

classDescriptor

Synopsis:
Account classDescriptor

Description:
Class descriptor for recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Schema ClassDescriptor

classDescriptor

Synopsis:
Portfolio classDescriptor

Description:
Class descriptor for recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Schema ClassDescriptor

classDescriptor

Synopsis:
AggAccount classDescriptor

Description:
Class descriptor for recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Schema ClassDescriptor

classDescriptor

Synopsis:
IndexAccount classDescriptor

Description:
Class descriptor for recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Schema ClassDescriptor

classDescriptor

Synopsis:
CompositeAccount classDescriptor

Description:
Class descriptor for recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Schema ClassDescriptor

cleanupClassStructures

Synopsis:
Entity cleanupClassStructures

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

Type: Method Function: DBAdmin Level: Basic
Returns: Object

cleanupClassStructures

Synopsis:
AggAccount cleanupClassStructures

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

Type: Method Function: DBAdmin Level: DBA
Returns: NoValue

cleanupClassStructures

Synopsis:
IndexAccount cleanupClassStructures

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

Type: Method Function: DBAdmin Level: DBA
Returns: NoValue

cleanupLocalNames

Synopsis:
Entity cleanupLocalNames

Description:
This method is executed by the 'flagForDeletionWithReason:' message and is redefined as needed by subclasses.

Type: Method Function: DBAdmin Level: Basic
Returns: Object

clusterStrings

Synopsis:
Entity clusterStrings

Type: Method Function: Not Defined Level: Basic
Returns: Object

componentList

Synopsis:
CompositeAccount componentList

Description:
IndexedList of components in recipient as of evaluation date.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: IndexedList of CompositeAccount Component

computeAccountTotals

Synopsis:
Account computeAccountTotals

Description:
Computes the total market values by asset category for recipient and updates the 'percentOfPort' and 'percentOfEquity' values for each of its holdings. This method is automatically run as part of the holdings creation process.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

createEvenDollarHoldingsAsOf:

Synopsis:
IndexAccount createEvenDollarHoldingsAsOf: date

Description:
Creates even dollar holdings for recipient as of supplied date using securities in 'memberList' as of that date. This method assumes that $1,000 of each security is held. The '_totalMarketValue' of each holding is therefore $1,000 and the '_shares' are set to 1000 / the security's price. Account totals are computed and 'percentOfPort' is updated for each holding.

Type: Method Function: Update Level: Advanced
Returns: NoValue
Parameters:
1 - Date

createEvenShareHoldingsAsOf:

Synopsis:
IndexAccount createEvenShareHoldingsAsOf: date

Description:
Creates even share holdings for recipient as of supplied date using securities in 'memberList' as of that date. This method assumes that 1,000 shares of each security is held. The '_shares' of each holding are set to 1000.00 and the '_totalMarketValue' is computed as 'price * shares' using the security's price. Account totals are computed and 'percentOfPort' is updated for each holding.

Type: Method Function: Update Level: Advanced
Returns: NoValue
Parameters:
1 - Date

createHoldingsFrom:

Synopsis:
Account createHoldingsFrom: xsecList

Description:
Creates holdings in the recipient using the supplied list of extended securities. List elements must be extended by the variables 'security', 'totalMarketValue', 'shares', 'totalCost', and, optionally, 'accountingPrice'.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue
Parameters:
1 - List

createHoldingsFrom:

Synopsis:
IndexAccount createHoldingsFrom: xsecList

Description:
Creates holdings in the recipient using the supplied list of extended securities. List elements must be extended by the variables 'security', 'totalMarketValue', 'shares', 'totalCost', and, optionally, 'accountingPrice'. The 'memberList' property is set to the unextended list of securities as of the evaluation and the 'universe' property is set to 'Default' and the 'style' property is set to 'Manual' as of this date.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue
Parameters:
1 - List

createHoldingsFromMembers

Synopsis:
IndexAccount createHoldingsFromMembers

Description:
Creates a holding object for each security in 'memberList' as of current evaluation date. The holding properties (e.g., '_shares' and '_totalMarketValue' are not initialized. This method is normally called by one of the other 'create...HoldingsAsOf:' messages, which fill in these property values.

Type: Method (time varying) Function: Update Level: Advanced
Returns: NoValue

createInitializationListFrom:

Synopsis:
Entity createInitializationListFrom: blockList

Description:
Creates a new class constant for the recipient's class named 'initializationList' and copies the blocks in blockList to this list. The initializationList is used during the instance creation process to initialize default values in the new instance.

Type: Method Function: Schema Level: Advanced
Returns: Entity
Parameters:
1 - List

createMCapWeightedHoldingsAsOf:

Synopsis:
IndexAccount createMCapWeightedHoldingsAsOf: date

Description:
Creates market-cap-weighted holdings for recipient as of supplied date using securities in 'memberList' as of that date. This method assumes that you hold the total market value of each holding is equal to the security's market capitalization. The '_shares' are set to this market value / the security's price. Account totals are computed and 'percentOfPort' is updated for each holding. This method assumes that the 'marketCap' method has been defined for security. All market cap values are accessed in the base currency of the recipient.

Type: Method Function: Update Level: Advanced
Returns: NoValue
Parameters:
1 - Date

createMValWeightedHoldingsAsOf:using:

Synopsis:
IndexAccount createMValWeightedHoldingsAsOf: date using: acct

Description:
Creates holdings for recipient as of supplied date using securities in 'memberList' as of that date based on the market value of the security in the supplied Account. This method assumes that you own the same number of shares that the supplied account has. If the supplied account does not own the security, the shares value in the recipient's holding will be 0. The '_totalMarketValue' is computed as 'price * shares' using the security's price. Account totals are computed and 'percentOfPort' is updated for each holding.

Type: Method Function: Update Level: Advanced
Returns: NoValue
Parameters:
1 - Date
2 - Account

createNewXRefManager

Synopsis:
Entity createNewXRefManager

Type: Method Function: Not Defined Level: Basic
Returns: Object

createPrivateStructure

Synopsis:
Entity createPrivateStructure

Type: Method Function: Not Defined Level: Basic
Returns: Object

createWeightedHoldingsAsOf:using:

Synopsis:
IndexAccount createWeightedHoldingsAsOf: date using: acct

Description:
Creates holdings extended by various statistics for recipient as of supplied date using securities in 'memberList' as of that date. This method assumes that you own the same number of shares that the supplied account has. The extension includes the property 'mvalEvenDollar' which is set to 1000, 'mvalMCapWeighted' which is set to the security's price (in recipient's base currency) * the security's 'sharesOut' value, and 'mvalMVWeighted' which is set to the security's price * the shares held in supplied account. The extension propeties 'pctEvenDollar', 'pctMCapWeighted', and 'pctMValWeighted' are computed relative to this list of holdings.

Type: Method Function: Update Level: Advanced
Returns: NoValue
Parameters:
1 - Date
2 - Account

createXRef:withProperty:

Synopsis:
Entity createXRef: id withProperty: propertyId

Type: Method Function: Not Defined Level: Basic
Returns: Object

dailyCutoff

Synopsis:
Account dailyCutoff

Description:
Constant used to determine the number of days of daily holdings to keep whenever the 'purgeHoldings' message is invoked.

Type: Constant Function: Update Level: DBA
Returns: DateOffset

defaultInstance

Synopsis:
Entity defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Function: Schema Level: Basic
Returns: Entity

defaultInstance

Synopsis:
Account defaultInstance

Description:
Default Account instance.

Type: Constant Function: Schema Level: Basic
Returns: Account

defaultInstance

Synopsis:
Portfolio defaultInstance

Description:
Returns the default Portfolio instance.

Type: Constant Function: Schema Level: Basic
Returns: Portfolio

defaultInstance

Synopsis:
AggAccount defaultInstance

Description:
Returns the default AggAccount instance.

Type: Constant Function: Schema Level: Basic
Returns: AggAccount

defaultInstance

Synopsis:
IndexAccount defaultInstance

Description:
Returns the default IndexAccount instance.

Type: Constant Function: Schema Level: Basic
Returns: IndexAccount

defaultInstance

Synopsis:
CompositeAccount defaultInstance

Description:
Returns the default CompositeAccount instance.

Type: Constant Function: Schema Level: Basic
Returns: CompositeAccount

deleteAlias:

Synopsis:
Entity deleteAlias: aliasList

Type: Method Function: Not Defined Level: Basic
Returns: Object

deleteCurrentHoldings

Synopsis:
Account deleteCurrentHoldings

Description:
Deletes holdings in the recipient as of current ^date.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

deleteMember:

Synopsis:
IndexAccount deleteMember: security

Description:
Deletes supplied security from 'memberList' as of current evaluation date.

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - Security

displayAggregateList

Synopsis:
Portfolio displayAggregateList

Description:
Displays list of AggAccount instances that include recipient.

Type: Method (time varying) Function: Display Level: Basic
Returns: NoValue

displayInfo

Synopsis:
Entity displayInfo

Description:
Displays the code and name for the recipient followed by a new line. This message is often redefined by the subclasses to display one line of simple formatted information about an entity.

Type: Method Function: Display Level: Basic
Returns: Object

displayLabel

Synopsis:
Entity displayLabel

Description:
Returns the recipient's name

Type: Method Function: Display Level: Basic
Returns: Object

displayLabelKey

Synopsis:
Entity displayLabelKey

Description:
Returns the recipient's code

Type: Method Function: Display Level: Basic
Returns: Object

displayXRefAuditReport

Synopsis:
Entity displayXRefAuditReport

Type: Method Function: Not Defined Level: Basic
Returns: Object

getHoldingIn:

Synopsis:
Account getHoldingIn: security

Description:
Returns Holding instance for the supplied security in the recipient. If security is not held, the default Holding is returned.

Type: Method (time varying) Function: Data Level: Basic
Returns: Holding
Parameters:
1 - Security

getMemberWeightsUsingAccount:

Synopsis:
IndexAccount getMemberWeightsUsingAccount: acct

Description:
Returns list of securities in 'memberList' as of evaluation date extended by the properties 'mvalEvenDollar' which stores the value 1000, 'pctEvenDollar' which stores the percent of index in this security based on even dollar market values, 'mvalMCapWeighted' which stores the security's 'price' * the security's 'sharesOut' in the recipient's currency, 'pctMCapWeighted' which stores the percent of index in this security based on market cap values, 'mvalMValWeighted' which stores the market value based on the number shares of this security in the supplied account as of the evaluation date, and 'pctMValWeighted' which stores the percent of index in this security based on the supplied accounts' market value.

Type: Method (time varying) Function: Data Level: Basic
Returns: List of Security
Parameters:
1 - Account

getMembers

Synopsis:
IndexAccount getMembers

Description:
Returns list of security members in recipient as of evaluation date. If 'membershipRule' is stored for recipient it is evalauted; otherwise, 'memberList' is converted to a List an returned.

Type: Method (time varying) Function: Data Level: Basic
Returns: List of Security

getOrCreate:

Synopsis:
Entity getOrCreate: string

Description:
Returns object named by string in recipient class' naming dictionary. If not found, a new instance is created and returned.

Type: Method Function: Access Level: Basic
Returns: Entity
Parameters:
1 - String

getRecordForUser:

Synopsis:
Entity getRecordForUser: userName

Type: Method Function: Not Defined Level: Basic
Returns: Object

hasHoldings

Synopsis:
Account hasHoldings

Description:
Does recipient have holdings as of current ^date?

Type: Method (time varying) Function: Data Level: Basic
Returns: Boolean

helpMessage

Synopsis:
Entity helpMessage

Description:
Returns a message describing the recipient.

Type: Method Function: Descriptive Level: Basic
Returns: String

holdings

Synopsis:
Account holdings

Description:
List of Holding objects for this recipient as of the current ^date.

Type: Method (time varying) Function: Data Level: Basic
Returns: List of Holding

holdingsDate

Synopsis:
Account holdingsDate

Description:
Actual date of the latest holdings available on or before current ^date.

Type: Method (time varying) Function: Data Level: Basic
Returns: Date

holdingsPrototype

Synopsis:
Account holdingsPrototype

Description:
Used to cluster 'holdingsSeries' list objects.

Type: Constant Function: Schema Level: DBA
Returns: List of Holding

holdingsSeries

Synopsis:
Account holdingsSeries

Description:
Time series of lists of holdings in recipient account.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: List of Holding

holds:

Synopsis:
Account holds: security

Description:
Is supplied security held by recipient?

Type: Method (time varying) Function: Data Level: Basic
Returns: Boolean
Parameters:
1 - Security

initializationList

Synopsis:
Entity initializationList

Description:
Returns the list of blocks used to initialize default values in new instances of the recipient's class.

Type: Constant Function: Schema Level: Advanced
Returns: List of Block

initializationList

Synopsis:
Account initializationList

Description:
Default values set on instance creation, this list includes 'baseCurrency'.

Type: Constant Function: Schema Level: DBA
Returns: List of Block

initializationList

Synopsis:
Portfolio initializationList

Description:
Default values set on instance creation, this list includes 'baseCurrency'.

Type: Constant Function: Schema Level: DBA
Returns: List of Block

initializationList

Synopsis:
AggAccount initializationList

Description:
Default values set on instance creation, this list includes 'baseCurrency'.

Type: Constant Function: Schema Level: DBA
Returns: List of Block

initializationList

Synopsis:
IndexAccount initializationList

Description:
Default values set on instance creation, this list includes 'baseCurrency'.

Type: Constant Function: Schema Level: DBA
Returns: List of Block

initializationList

Synopsis:
CompositeAccount initializationList

Description:
Default values set on instance creation, this list includes 'baseCurrency'.

Type: Constant Function: Schema Level: DBA
Returns: List of Block

initialize

Synopsis:
Entity initialize

Description:
Initializes a new instance. Run as part of the instance creation process.

Type: Method Function: Creation Level: Advanced
Returns: Entity

initialize

Synopsis:
Account initialize

Description:
Initializes properties in newly created instance.

Type: Method Function: Creation Level: DBA
Returns: Account

initialize

Synopsis:
Portfolio initialize

Description:
Initializes properties in newly created instance.

Type: Method Function: Creation Level: Basic
Returns: Portfolio

initialize

Synopsis:
AggAccount initialize

Description:
Initializes properties in newly created instance.

Type: Method Function: Creation Level: DBA
Returns: AggAccount

initialize

Synopsis:
IndexAccount initialize

Description:
Initializes properties in newly created instance.

Type: Method Function: Creation Level: Basic
Returns: IndexAccount

initialize

Synopsis:
CompositeAccount initialize

Description:
Initializes properties in newly created instance.

Type: Method Function: Creation Level: DBA
Returns: CompositeAccount

initializeComponentList

Synopsis:
CompositeAccount initializeComponentList

Description:
Creates a new IndexedList and stores it in 'componentList' time series as of current evaluation date (^date).

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

initializeDailyHoldingsBasedValues

Synopsis:
Account initializeDailyHoldingsBasedValues

Description:
Initializes time series properties prior to holdings creation for recipient. The 'holdingsSeries' is set to the empty list (holdingsPrototype) and the total market value and cost properties are set to NA for the current evaluation date (^date).

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

initializeDailySummaryValues

Synopsis:
Account initializeDailySummaryValues

Description:
Initializes properties prior to holdings creation for recipient. This method can be used to initialize other account-related properties, not initialized with 'initializeDailyHoldingsBasedValues.

Type: Method Function: Update Level: DBA
Returns: NoValue

initializeDataBaseLinks

Synopsis:
Entity initializeDataBaseLinks

Description:
Initializes a new instance. Run as part of the instance creation process.

Type: Method Function: Creation Level: Advanced
Returns: Entity

initializeForHoldingsPrecalcs

Synopsis:
Account initializeForHoldingsPrecalcs

Description:
Initializes properties prior to holdings creation for all Accounts and Securities. This method should be run in environments where all portfolios are updated at the same time and any portfolio not included in an update needs to have its values reset to NA.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

initializeGlobalInstanceProperties

Synopsis:
Entity initializeGlobalInstanceProperties

Description:
Initializes a new instance. Run as part of the instance creation process.

Type: Method Function: Creation Level: Advanced
Returns: Entity

initializeGlobalSubclassProperties

Synopsis:
Entity 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: Object

initializeLocalAttributes

Synopsis:
Entity initializeLocalAttributes

Description:
Initializes a new instance. Run as part of the instance creation process.

Type: Method Function: Creation Level: Advanced
Returns: Entity

initializeNewMembershipDate

Synopsis:
IndexAccount initializeNewMembershipDate

Description:
Creates a new IndexedList and stores it in 'memberList' time series as of current evaluation date (^date).

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount

isAccount

Synopsis:
Account isAccount

Description:
Returns the value TRUE.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

isAggAccount

Synopsis:
AggAccount isAggAccount

Description:
Returns the value TRUE.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

isCompositeAccount

Synopsis:
CompositeAccount isCompositeAccount

Description:
Returns the value TRUE.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

isEntity

Synopsis:
Entity isEntity

Description:
Returns the value TRUE when sent to any Entity.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

isIndexAccount

Synopsis:
IndexAccount isIndexAccount

Description:
Returns the value TRUE.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

isMemberOf:

Synopsis:
Entity isMemberOf: universe

Type: Method (time varying) Function: Data Level: Basic
Returns: Boolean
Parameters:
1 - Universe

isPortfolio

Synopsis:
Portfolio isPortfolio

Description:
Returns the value TRUE.

Type: Constant Function: Inquiry Level: Basic
Returns: TRUE

locateId:

Synopsis:
Entity locateId: string

Description:
Returns entity associated with id supplied, searching naming dictionaries associated with entity class. By default only 'named' is searched; this message can be redefined for subclasses that can use multiple dictionaries.

Type: Method Function: Access Level: Basic
Returns: Entity
Parameters:
1 - String

locateId:

Synopsis:
Account locateId: id

Description:
Returns the Account object associated with the supplied id. If the message is sent directly to 'Account', the naming dictionary search order starts with Named Account, followed by Named Portfolio, Named AggAccount, Named IndexAccount, and Named CompositeAccount. If the message is set to a subclass of 'Account', just that subclass' naming dictionary is used.

Type: Method Function: Access Level: Basic
Returns: Account
Parameters:
1 - String

locateIds:

Synopsis:
Entity locateIds: string

Type: Method Function: Not Defined Level: Basic
Returns: Object

masterListCodes

Synopsis:
Entity masterListCodes

Description:
Displays all codes and names for all non-default instances in recipient's class.

Type: Method Function: Display Level: Basic
Returns: Object

memberList

Synopsis:
AggAccount memberList

Description:
IndexedList of portfolios in recipient as of evaluation date.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: IndexedList of Portfolio
Parameters:
1 - Portfolio

memberList

Synopsis:
IndexAccount memberList

Description:
IndexedList of securities in recipient as of evaluation date.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: IndexedList of Security
Parameters:
1 - Security

memberListPrototype

Synopsis:
AggAccount memberListPrototype

Description:
Used to cluster 'memberList' list objects.

Type: Constant Function: Creation Level: DBA
Returns: IndexedList of Portfolio

memberListPrototype

Synopsis:
IndexAccount memberListPrototype

Description:
Used to cluster 'memberList' list objects.

Type: Constant Function: Creation Level: DBA
Returns: IndexedList of Portfolio

membershipRule

Synopsis:
AggAccount membershipRule

Description:
Block used to derive memberList. Not currently supported.

Type: FixedProperty Function: Data Level: Reserved
Returns: Block

membershipRule

Synopsis:
IndexAccount membershipRule

Description:
Block used to derive memberList. Not currently supported.

Type: FixedProperty Function: Data Level: Reserved
Returns: Block

name

Synopsis:
Entity name

Description:
Returns descriptive name for recipient.

Type: FixedProperty Function: Descriptive Level: Basic
Returns: String

named

Synopsis:
Entity named

Description:
Returns the naming dictionary for the recipient's class.

Type: Constant Function: Descriptive Level: Basic
Returns: Dictionary

named

Synopsis:
Account named

Description:
Naming dictionary associated with recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Named

named

Synopsis:
Portfolio named

Description:
Naming dictionary associated with recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Named

named

Synopsis:
AggAccount named

Description:
Naming dictionary associated with recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Named

named

Synopsis:
IndexAccount named

Description:
Naming dictionary associated with recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Named

named

Synopsis:
CompositeAccount named

Description:
Naming dictionary associated with recipient's class.

Type: Constant Function: Schema Level: Basic
Returns: Named

newAs:

Synopsis:
Entity newAs: string

Description:
Special version of 'newAs:' message designed to address the additional requirements of entity instance creation.

Type: Method Function: Creation Level: Basic
Returns: Entity

numericCode

Synopsis:
Entity numericCode

Description:
Returns descriptive numeric code for recipient.

Type: FixedProperty Function: Descriptive Level: Basic
Returns: String

print

Synopsis:
Entity print

Description:
Redefines the standard print message so that the value of the recipient code is printed.

Type: Method Function: Display Level: Basic
Returns: Entity

print:

Synopsis:
Entity print: anInteger

Description:
Prints the recipient code using the supplied format.

Type: Method Function: Display Level: Basic
Returns: Entity
Parameters:
1 - Integer

profile

Synopsis:
Entity profile

Description:
Displays a multi-line description of the recipient object.

Type: Method Function: Display Level: Basic
Returns: Object

profile

Synopsis:
Account profile

Description:
Basic descriptive report about the recipient.

Type: Method Function: Display Level: Basic
Returns: NoValue

profile

Synopsis:
Portfolio profile

Description:
Basic descriptive report about the recipient.

Type: Method Function: Display Level: Basic
Returns: NoValue

profile

Synopsis:
AggAccount profile

Description:
Basic descriptive report about the recipient.

Type: Method Function: Display Level: Basic
Returns: NoValue

profile

Synopsis:
IndexAccount profile

Description:
Basic descriptive report about the recipient.

Type: Method Function: Display Level: Basic
Returns: NoValue

profile

Synopsis:
CompositeAccount profile

Description:
Basic descriptive report about the recipient.

Type: Method Function: Display Level: Basic
Returns: NoValue

purgeHoldings

Synopsis:
Account purgeHoldings

Description:
Deletes all holdings in recipient as of ^date, and removes the empty list from 'holdingsSeries' on that date.

Type: Method (time varying) Function: Update Level: DBA
Returns: NoValue

purgeOldHoldingsForAll

Synopsis:
Account purgeOldHoldingsForAll

Description:
For any account having holdings, this method purges all holdings that are not for the last day (or business day) of the month that are older than the 'dailyCutoff'-specified increment. For each date that is purge, the corresponding security holdings structures are also cleared.

Type: Method Function: Update Level: DBA
Returns: NoValue

rebuildAliases

Synopsis:
Entity rebuildAliases

Type: Method Function: Not Defined Level: Basic
Returns: Object

setMembershipRuleTo:

Synopsis:
AggAccount setMembershipRuleTo: block

Description:
Updates the 'membershipRule' property. Not currently supported.

Type: Method Function: Update Level: DBA
Returns: AggAccount
Parameters:
1 - Block

setMembershipRuleTo:

Synopsis:
IndexAccount setMembershipRuleTo: block

Description:
Updates the 'membershipRule' property. Not currently supported.

Type: Method Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - Block

setNameTo:

Synopsis:
Entity setNameTo: string

Description:
Updates the value of the recipient's 'name' property with string

Type: Method Function: Update Level: Basic
Returns: Entity
Parameters:
1 - String

setNumericCodeTo:

Synopsis:
Entity setNumericCodeTo: ordinal

Description:
Updates the value of the recipient's 'numericCode' property with string or number. Used as an alternative identification scheme.

Type: Method Function: Update Level: Basic
Returns: Entity
Parameters:
1 - Ordinal

setSecuritiesTo:asOf:

Synopsis:
IndexAccount setSecuritiesTo: list asOf: date

Description:
Updates 'memberList' property with supplied list of securities on supplied date.

Type: Method Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - List
2 - Date

setShortNameTo:

Synopsis:
Entity setShortNameTo: string

Description:
Updates the value of the recipient's 'shortName' property with string.

Type: Method Function: Update Level: Basic
Returns: Entity
Parameters:
1 - String

setSortCodeTo:

Synopsis:
Entity setSortCodeTo: ordinal

Description:
Updates the value of the recipient's 'sortCode' property with string or number. Used as an alternative identification scheme.

Type: Method Function: Update Level: Basic
Returns: Entity
Parameters:
1 - Ordinal

setStyleTo:

Synopsis:
IndexAccount setStyleTo: input

Description:
Sets 'style' to supplied value as of current evaluation date (^date).

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - String

setUniverseTo:

Synopsis:
IndexAccount setUniverseTo: input

Description:
Sets 'universe' to supplied Universe instance as of current evaluation date (^date) and updates 'memberList' with securities in that universe as of the same date.

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount
Parameters:
1 - Universe

setXRefIn:to:

Synopsis:
Entity setXRefIn: dictionary to: string

Type: Method Function: Not Defined Level: Basic
Returns: Object

shortName

Synopsis:
Entity shortName

Description:
Returns descriptive shortName for recipient.

Type: FixedProperty Function: Descriptive Level: Basic
Returns: String

sortCode

Synopsis:
Entity sortCode

Description:
Returns descriptive sortCode for recipient.

Type: FixedProperty Function: Descriptive Level: Basic
Returns: String

specializeAs:at:

Synopsis:
Entity specializeAs: string at: object

Description:
Creates a subclass of recipient named by supplied string. The name is defined at the supplied object. Note that this class is NOT installed in the Schema database by default

Type: Method Function: Creation Level: Basic
Returns: Object

style

Synopsis:
IndexAccount style

Description:
Style used to derive holding shares and market value.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: String

totalCost

Synopsis:
Account totalCost

Description:
Total cost of holdings (adjusted to current currency).

Type: Method (time varying) Function: Data Level: Basic
Returns: Number

totalMarketValue

Synopsis:
Account totalMarketValue

Description:
Total market value of holdings (adjusted to current currency).

Type: Method (time varying) Function: Data Level: Basic
Returns: Number

totalMarketValueCash

Synopsis:
Account totalMarketValueCash

Description:
Total market value of cash holdings (adjusted to current currency).

Type: Method (time varying) Function: Data Level: Basic
Returns: Number

totalMarketValueEquity

Synopsis:
Account totalMarketValueEquity

Description:
Total market value of equity holdings (adjusted to current currency).

Type: Method (time varying) Function: Data Level: Basic
Returns: Number

totalMarketValueFixed

Synopsis:
Account totalMarketValueFixed

Description:
Total market value of fixed income holdings (adjusted to current currency).

Type: Method (time varying) Function: Data Level: Basic
Returns: Number

uniqueId

Synopsis:
Account uniqueId

Description:
Unique identification for the recipient among all account classes.

Type: FixedProperty Function: Data Level: Basic
Returns: String

universe

Synopsis:
IndexAccount universe

Description:
Universe used to retrieve security members.

Type: TimeSeriesProperty Function: Data Level: Basic
Returns: Universe

universes

Synopsis:
Entity universes

Type: Method (time varying) Function: Data Level: Basic
Returns: List of Universe

updateInitializationListWith:

Synopsis:
Entity updateInitializationListWith: block

Description:
Adds the supplied block to the recipient class' initializationList.

Type: Method Function: Schema Level: Advanced
Returns: Entity
Parameters:
1 - Block

updateMemberships

Synopsis:
IndexAccount updateMemberships

Description:
If 'membershipRule' is defined, it is used to update the securities in 'memberList' as of current evaluation date.

Type: Method (time varying) Function: Update Level: DBA
Returns: IndexAccount

validateInputString:

Synopsis:
Entity validateInputString: input

Description:
Returns the object in the recipient's classs associated with the supplied string, using the recipient's class naming dictionary.

Type: Method Function: Inquiry Level: Basic
Returns: Object

whatAmI

Synopsis:
Entity whatAmI

Description:
Return the string "Entity".

Type: Constant Function: Descriptive Level: Basic
Returns: String

whatAmI

Synopsis:
Account whatAmI

Description:
Returns the string "Account".

Type: Constant Function: Schema Level: Basic
Returns: String

whatAmI

Synopsis:
Portfolio whatAmI

Description:
Returns the string "Portfolio".

Type: Constant Function: Schema Level: Basic
Returns: String

whatAmI

Synopsis:
AggAccount whatAmI

Description:
Returns the string "AggAccount".

Type: Constant Function: Schema Level: Basic
Returns: String

whatAmI

Synopsis:
IndexAccount whatAmI

Description:
Returns the string "IndexAccount".

Type: Constant Function: Schema Level: Basic
Returns: String

whatAmI

Synopsis:
CompositeAccount whatAmI

Description:
Returns the string "CompositeAccount".

Type: Constant Function: Schema Level: Basic
Returns: String