Vision Messages: Security

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

Profile of Class Security

Includes Classes: Entity, Security 


Object
  | 
Entity
  | 
  +--- Security

Instances of the Security class represent the individual securities issued by a company or equivalent entity such as the government. A variety of security types may exist including cash, common and preferred stocks, convertible and non-convertible bonds, and put and call options. Data maintained for a security typically includes price, dividend and shares/amount outstanding information. Portfolios hold specific amounts of one or more securities.

Message Index

o XRef (Entity)
o XRef (Security)
o _sharesOut (Security)
o accessExpression (Entity)
o addAlias: alias (Entity)
o addAlias: string (Security)
o addAlias: string toXRefIn: dictionary (Entity)
o addSplitFactorOf: aFactor onExDate: aDate (Security)
o adjustmentFactor (Security)
o adjustmentRelativeTo: aDate (Security)
o aliases (Entity)
o asSelf (Entity)
o asSelf (Security)
o canCusip (Security)
o canCusip8 (Security)
o classDescriptor (Entity)
o classDescriptor (Security)
o cleanupClassStructures (Entity)
o cleanupHoldingsAsOf: date (Security)
o cleanupLocalNames (Entity)
o cleanupLocalNames (Security)
o clusterStrings (Entity)
o company (Security)
o createAndLink: id (Security)
o createInitializationListFrom: initList (Entity)
o createNewXRefManager (Entity)
o createPrivateStructure (Entity)
o createXRef: id withProperty: propertyId (Entity)
o cusip (Security)
o cusip8 (Security)
o defaultInstance (Entity)
o defaultInstance (Security)
o deleteAlias: aliasList (Entity)
o deleteAlias: string (Security)
o deleteCurrentHoldings (Security)
o displayInfo (Entity)
o displayInfo (Security)
o displayLabel (Entity)
o displayLabelKey (Entity)
o displayXRefAuditReport (Entity)
o dividend (Security)
o dividendSeries (Security)
o dividends (Security)
o getAdjustedDataFor: aTimeSeries (Security)
o getAdjustedSharesDataFor: aTimeSeries (Security)
o getAggAccounts (Security)
o getDivsFrom: date1 to: date2 (Security)
o getHoldingIn: portfolio (Security)
o getIndexAccounts (Security)
o getOrCreate: key (Entity)
o getPriceRecord (Security)
o getRecordForUser: userName (Entity)
o heldIn: portfolio (Security)
o helpMessage (Entity)
o holdings (Security)
o holdingsDate (Security)
o holdingsPrototype (Security)
o holdingsSeries (Security)
o id (Security)
o initializationList (Entity)
o initializationList (Security)
o initialize (Entity)
o initialize (Security)
o initializeDataBaseLinks (Entity)
o initializeForHoldingsPrecalcs (Security)
o initializeGlobalInstanceProperties (Entity)
o initializeGlobalSubclassProperties (Entity)
o initializeLocalAttributes (Entity)
o isEntity (Entity)
o isMemberOf: universe (Entity)
o isSecurity (Security)
o isin (Security)
o locateId: id (Entity)
o locateId: id (Security)
o locateIds: string (Entity)
o masterListCodes (Entity)
o name (Entity)
o named (Entity)
o named (Security)
o newAs: string (Entity)
o numericCode (Entity)
o price (Security)
o priceChangeFrom: date1 to: date2 (Security)
o prices (Security)
o pricingSeries (Security)
o print (Entity)
o print: aFormat (Entity)
o profile (Entity)
o profile (Security)
o purgeHoldings (Security)
o rawSplitFactor (Security)
o rebuildAdjustmentFactor (Security)
o rebuildAliases (Entity)
o rebuildHoldings (Security)
o resetCanCusipTo: string (Security)
o resetCodeTo: string (Security)
o resetCompany (Security)
o resetCusipTo: string (Security)
o resetIsinTo: string (Security)
o resetSedolTo: string (Security)
o resetValorTo: string (Security)
o sedol (Security)
o sedol6 (Security)
o setCanCusipTo: string (Security)
o setCompanyTo: comp (Security)
o setCusipTo: string (Security)
o setIsinTo: string (Security)
o setNameTo: string (Entity)
o setNumericCodeTo: string (Entity)
o setSedolTo: string (Security)
o setShortNameTo: string (Entity)
o setSortCodeTo: string (Entity)
o setTickerTo: string (Security)
o setTypeTo: sectype (Security)
o setValorTo: string (Security)
o setXRefIn: dictionary to: string (Entity)
o sharesOut (Security)
o shortName (Entity)
o sortCode (Entity)
o specializeAs: string at: object (Entity)
o ticker (Security)
o totalReturnFrom: date1 to: date2 (Security)
o type (Security)
o universes (Entity)
o updateInitializationListWith: block (Entity)
o validateInputString: input (Entity)
o valor (Security)
o volume (Security)
o whatAmI (Entity)
o whatAmI (Security)

Messages

o XRef

Synopsis:
Entity XRef

Description:

Provides cross reference for alternative identifiers.

Type: Constant          Function: Schema          Level: DBA

Returns: XRef

o XRef

Synopsis:
Security XRef

Description:

Provides cross reference for alternative identifiers.

Type: Constant          Function: Schema          Level: DBA

Returns: Security XRef

o _sharesOut

Synopsis:
Security _sharesOut

Description:

Shares outstanding (unadjusted for splits).

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

Returns: Number

o accessExpression

Synopsis:
Entity accessExpression

Description:

Returns a string that could be used to request recipient

Type: Method          Function: Format          Level: Advanced

Returns: String

o addAlias:

Synopsis:
Entity addAlias: alias

Description:

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

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String

o addAlias:

Synopsis:
Security addAlias: string

Description:

Adds the parameter as an alias in Named Security. The alias is also added to the Named Company dictionary if the recipient is associated with a non-default Company.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o addAlias:toXRefIn:

Synopsis:
Entity addAlias: string toXRefIn: dictionary

Description:

Adds the supplied string as an alias in the supplied cross reference dictionary.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String
2 - XRef

o addSplitFactorOf:onExDate:

Synopsis:
Security addSplitFactorOf: aFactor onExDate: aDate

Description:

Adds the supplied split factor to the recipient's 'rawSplitFactor' on the supplied date. A 2-for-1 stock split should get added with a factor of 2.0. A 10% stock dividend should get added with a factor of 1.1.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - Number
2 - Date

o adjustmentFactor

Synopsis:
Security adjustmentFactor

Description:

Cumulative adjustment factor. This property has an initial value of 1.0. Each time a split occurs, a new point representing the product of the new raw factor and the last adjustment factor is stored in this property as of the ex-date. To properly use the adjustment factor, you access values as of the two dates involved, the adjustment date and the current date. The ratio of these factors gives you the correct adjustment.

Type: TimeSeriesProperty          Function: Data          Level: Basic

Returns: Number

o adjustmentRelativeTo:

Synopsis:
Security adjustmentRelativeTo: aDate

Description:

Adjustment value that accounts for any splits in the recipient since supplied date. This value will be 1.0 if no splits have occurred. The value is used to adjust historic per-share and shares outstanding data.

Type: Method          Function: Data          Level: Basic

Returns: Number

Parameters:

1 - Date

o aliases

Synopsis:
Entity aliases

Description:

Returns list of aliases defined for recipient. These aliases should represent valid identifier to use with the recipient's naming dictionary.

Type: FixedProperty          Function: Data          Level: Basic

Returns: List of String

o asSelf

Synopsis:
Entity asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Entity

o asSelf

Synopsis:
Security asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Security

o canCusip

Synopsis:
Security canCusip

Description:

Canadian cusip.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o canCusip8

Synopsis:
Security canCusip8

Description:

First 8 characters of canadian cusip.

Type: Method          Function: Data          Level: Basic

Returns: String

o classDescriptor

Synopsis:
Entity classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Security classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o 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: DBA

Returns: NoValue

o cleanupHoldingsAsOf:

Synopsis:
Security cleanupHoldingsAsOf: date

Description:

Deletes holdingsSeries lists for all Securities as of supplied date. This method is normally run as part of the purging of holdings for all accounts ('Account purgeOldHoldingsForAll').

Type: Method          Function: Update          Level: DBA

Returns: NoValue

Parameters:

1 - Date

o cleanupLocalNames

Synopsis:
Entity cleanupLocalNames

Description:

This method is executed by the 'flagForDeletionWithReason:' message and is used to remove aliases from the appropriate naming dictionaries.

Type: Method          Function: DBAdmin          Level: DBA

Returns: NoValue

o cleanupLocalNames

Synopsis:
Security cleanupLocalNames

Description:

Deletes cusip8 and sedol6 aliases from appropriate naming dictionaries.

Type: Method          Function: DBAdmin          Level: DBA

Returns: NoValue

o clusterStrings

Synopsis:
Entity clusterStrings

Description:

Reclusters string property values.

Type: Method          Function: DBAdamin          Level: DBA

Returns: NoValue

o company

Synopsis:
Security company

Description:

Company issuing the recipient.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Company

o createAndLink:

Synopsis:
Security createAndLink: id

Description:

Creates Security and/or Company using supplied id. The security's 'company' is set to this company. The company's 'primarySecurity' is set to this security if it is currently not set.

Type: Method          Function: Creation          Level: DBA

Returns: Security

Parameters:

1 - String

o createInitializationListFrom:

Synopsis:
Entity createInitializationListFrom: initList

Description:

Creates a new class constant for the recipient's class named 'initializationList' and copies the list of blocks in supplied parameter 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: DBA

Returns: Entity

Parameters:

1 - List

o createNewXRefManager

Synopsis:
Entity createNewXRefManager

Description:

Creates a new XRef manager as a class constant for the recipient's class and stores the Default reference to the recipient's class naming dictionary.

Type: Method          Function: Schema          Level: DBA

Returns: XRef

o createPrivateStructure

Synopsis:
Entity createPrivateStructure

Description:

Creates private extension of recipient's class.

Type: Method          Function: Schema          Level: DBA

Returns: PrivateRecord

o createXRef:withProperty:

Synopsis:
Entity createXRef: id withProperty: propertyId

Description:

Creates a new XRef for recipient's class and defines the supplied property for this class.

Type: Method          Function: Schema          Level: DBA

Returns: XRef

Parameters:

1 - String
2 - String

o cusip

Synopsis:
Security cusip

Description:

Cusip identifier.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o cusip8

Synopsis:
Security cusip8

Description:

First 8 characters of cusip.

Type: Method          Function: Data          Level: Basic

Returns: Object

o defaultInstance

Synopsis:
Entity defaultInstance

Description:

Returns the default Entity instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Entity

o defaultInstance

Synopsis:
Security defaultInstance

Description:

Returns the default Security instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Security

o deleteAlias:

Synopsis:
Entity deleteAlias: aliasList

Description:

Deletes the alias from the recipient's naming dictionary.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String

o deleteAlias:

Synopsis:
Security deleteAlias: string

Description:

Deletes the alias from the Named Security and Name Company dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o deleteCurrentHoldings

Synopsis:
Security deleteCurrentHoldings

Description:

Deletes holdingsSeries list as of ^date. This method is normally run as part of a global purge of old holdings.

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

Returns: NoValue

o 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: NoValue

o displayInfo

Synopsis:
Security displayInfo

Description:

One line display of code, ticker, and name.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o displayLabel

Synopsis:
Entity displayLabel

Description:

Returns recipient's name by default. This message is often redefined by the Entity subclasses.

Type: Method          Function: Display          Level: Basic

Returns: String

o displayLabelKey

Synopsis:
Entity displayLabelKey

Description:

Returns the recipient's code by default. This message is often redefined by the Entity subclasses.

Type: Method          Function: Display          Level: Basic

Returns: String

o displayXRefAuditReport

Synopsis:
Entity displayXRefAuditReport

Description:

Displays a report summarizing the different XRef dictionaries defined for recipient's class.

Type: Method          Function: Display          Level: DBA

Returns: NoValue

o dividend

Synopsis:
Security dividend

Description:

Last cash dividend paid on or before ^date (adjusted for splits and currency).

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

Returns: Number

o dividendSeries

Synopsis:
Security dividendSeries

Description:

Last DivRecord on or before ^date.

Type: TimeSeriesProperty          Function: Data          Level: Basic

Returns: DivRecord

o dividends

Synopsis:
Security dividends

Description:

TimeSeries of all DivRecords for the recipient.

Type: Method          Function: Data          Level: Basic

Returns: TimeSeries of DivRecord

o getAdjustedDataFor:

Synopsis:
Security getAdjustedDataFor: aTimeSeries

Description:

Returns the value of the supplied time series as of ^date, adjusted for any splits that have occurred since the value went into effect. The raw value in the time series is divided by the adjustment (i.e., per share).

Type: Method (time varying)          Function: Data          Level: Advanced

Returns: Number

Parameters:

1 - TimeSeries

o getAdjustedSharesDataFor:

Synopsis:
Security getAdjustedSharesDataFor: aTimeSeries

Description:

Returns the value of the supplied time series as of ^date, adjusted for any splits that have occurred since the value went into effect. The raw value in the time series is multipled by the adjustment (i.e., shares out).

Type: Method (time varying)          Function: Data          Level: Advanced

Returns: Number

Parameters:

1 - TimeSeries

o getAggAccounts

Synopsis:
Security getAggAccounts

Description:

List of AggAccounts holding recipient.

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

Returns: List of AggAccount

o getDivsFrom:to:

Synopsis:
Security getDivsFrom: date1 to: date2

Description:

Total cash dividend paid between two supplied dates.

Type: Method          Function: Data          Level: Basic

Returns: Number

Parameters:

1 - Date
2 - Date

o getHoldingIn:

Synopsis:
Security getHoldingIn: portfolio

Description:

If recipient is held by supplied Portfolio, the Holdng is returned. If it is not held, the default Holding is returned.

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

Returns: Holding

Parameters:

1 - Portfolio

o getIndexAccounts

Synopsis:
Security getIndexAccounts

Description:

List of IndexAccounts that include recipient.

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

Returns: List of IndexAccount

o getOrCreate:

Synopsis:
Entity getOrCreate: key

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: DBA

Returns: Entity

Parameters:

1 - String

o getPriceRecord

Synopsis:
Security getPriceRecord

Description:

Latest PriceRecord on or before ^date.

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

Returns: PriceRecord

o getRecordForUser:

Synopsis:
Entity getRecordForUser: userName

Description:

Returns private data extension for recipient maintained by specified user.

Type: Method          Function: Access          Level: Advanced

Returns: PrivateRecord

Parameters:

1 - String

o heldIn:

Synopsis:
Security heldIn: portfolio

Description:

Is recipient held in supplied Portfolio?

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

Returns: Boolean

Parameters:

1 - Portfolio

o helpMessage

Synopsis:
Entity helpMessage

Description:

Returns a message describing the recipient.

Type: Method          Function: Descriptive          Level: Basic

Returns: String

o holdings

Synopsis:
Security holdings

Description:

List of Holding instances that reference recipient. Holdings list are maintained over time and reflect all Portfolios that owned recipient as of a date.

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

Returns: List of Holding

o holdingsDate

Synopsis:
Security holdingsDate

Description:

Effective date of holdings relative to ^date.

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

Returns: Date

o holdingsPrototype

Synopsis:
Security holdingsPrototype

Description:

Used to cluster 'holdingsSeries' list objects.

Type: Constant          Function: Schema          Level: DBA

Returns: List of Holding

o holdingsSeries

Synopsis:
Security holdingsSeries

Description:

TimeSeries of Lists of Holdings of recipient security.

Type: TimeSeriesProperty          Function: Data          Level: Basic

Returns: List of Holding

o id

Synopsis:
Security id

Description:

Returns the ticker if non-NA, the code otherwise.

Type: Method          Function: Data          Level: Basic

Returns: String

o 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: DBA

Returns: List of Block

o initializationList

Synopsis:
Security initializationList

Description:

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

Type: Constant          Function: Schema          Level: DBA

Returns: List of Block

o initialize

Synopsis:
Entity initialize

Description:

Initializes properties in newly created instance.

Type: Method          Function: Creation          Level: DBA

Returns: Entity

o initialize

Synopsis:
Security initialize

Description:

Initializes properties in newly created instance.

Type: Method          Function: Creation          Level: DBA

Returns: Security

o initializeDataBaseLinks

Synopsis:
Entity initializeDataBaseLinks

Description:

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

Type: Method          Function: Creation          Level: DBA

Returns: Entity

o initializeForHoldingsPrecalcs

Synopsis:
Security initializeForHoldingsPrecalcs

Description:

Initializes properties prior to holdings cross reference for securities.

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

Returns: NoValue

o initializeGlobalInstanceProperties

Synopsis:
Entity initializeGlobalInstanceProperties

Description:

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

Type: Method          Function: Creation          Level: DBA

Returns: Entity

o 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: DBA

Returns: Entity

o initializeLocalAttributes

Synopsis:
Entity initializeLocalAttributes

Description:

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

Type: Method          Function: Creation          Level: DBA

Returns: Entity

o isEntity

Synopsis:
Entity isEntity

Description:

Returns the value TRUE when sent to any Entity.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isMemberOf:

Synopsis:
Entity isMemberOf: universe

Description:

Returns TRUE if recipient is a member of supplied Universe or Classification.

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

Returns: Boolean

Parameters:

1 - Universe

o isSecurity

Synopsis:
Security isSecurity

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isin

Synopsis:
Security isin

Description:

Isin code.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o locateId:

Synopsis:
Entity locateId: id

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

o locateId:

Synopsis:
Security locateId: id

Description:

Returns the Security object associated with the supplied id. If the id is not found in the Named Security dictionary, the Cusip, Sedol, CanCusip, Valor, and Isin XRef dictionaries are searched in order until a match is found. If no match is found, NA is returned.

Type: Method          Function: Access          Level: Basic

Returns: Security

Parameters:

1 - String

o locateIds:

Synopsis:
Entity locateIds: string

Description:

Returns a list of entities of recipient's class. The parameter should be supplied as a single string with the ',' character used to separate the ids to locate (e.g., "GM, IBM, XON" ).

Type: Method          Function: Access          Level: Basic

Returns: List of Entity

Parameters:

1 - String

o masterListCodes

Synopsis:
Entity masterListCodes

Description:

Displays code and name for all non-default instances in recipient's class.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o name

Synopsis:
Entity name

Description:

recipient's name.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o named

Synopsis:
Entity named

Description:

Naming dictionary for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Dictionary

o named

Synopsis:
Security named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o 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: DBA

Returns: Entity

Parameters:

1 - String

o numericCode

Synopsis:
Entity numericCode

Description:

Numeric code. This value can be used to assign numeric orderings for instances of a class.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o price

Synopsis:
Security price

Description:

Closing price for recipient (adjusted for splits and currency).

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

Returns: Number

o priceChangeFrom:to:

Synopsis:
Security priceChangeFrom: date1 to: date2

Description:

Percent change in price between two supplied dates.

Type: Method          Function: Data          Level: Basic

Returns: Number

Parameters:

1 - Date
2 - Date

o prices

Synopsis:
Security prices

Description:

TimeSeries of all PriceRecords for recipient.

Type: Method          Function: Data          Level: Basic

Returns: TimeSeries of PriceRecord

o pricingSeries

Synopsis:
Security pricingSeries

Description:

Multi-level pricing structure used to efficiently store references to the PriceRecords associated with the reicpient.

Type: TimeSeriesProperty          Function: DBAdmin          Level: Advanced

Returns: TimeSeries of TimeSeries

o print

Synopsis:
Entity print

Description:

Redefines the standard print message so that recipient's 'code' is printed.

Type: Method          Function: Display          Level: Basic

Returns: Entity

o print:

Synopsis:
Entity print: aFormat

Description:

Prints recipient's 'code' using supplied format.

Type: Method          Function: Display          Level: Basic

Returns: Entity

Parameters:

1 - Integer

o profile

Synopsis:
Entity profile

Description:

Displays a multi-line description of recipient.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o profile

Synopsis:
Security profile

Description:

Basic descriptive report about the recipient.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

o purgeHoldings

Synopsis:
Security purgeHoldings

Description:

Removes list from 'holdingsSeries' on ^date.

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

Returns: NoValue

o rawSplitFactor

Synopsis:
Security rawSplitFactor

Description:

Records stock split and stock dividends for the recipient by ex-date. A 2-for-1 stock split is stored as a 2.0. A 10% stock dividend is stored as a 1.1.

Type: TimeSeriesProperty          Function: Data          Level: Basic

Returns: Number

o rebuildAdjustmentFactor

Synopsis:
Security rebuildAdjustmentFactor

Description:

Rebuilds the 'adjustmentFactor' time series for the recipient using the values in 'rawSplitFactor'.

Type: Method          Function: Update          Level: DBA

Returns: NoValue

o rebuildAliases

Synopsis:
Entity rebuildAliases

Description:

Rebuilds the 'aliases' list for all instances of recipient's using the current selector in recpient's naming dictionary.

Type: Method          Function: Schema          Level: DBA

Returns: NoValue

o rebuildHoldings

Synopsis:
Security rebuildHoldings

Description:

Rebuilds the holdings cross reference for all securities. The holdings for all Portfolio instances are included.

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

Returns: NoValue

o resetCanCusipTo:

Synopsis:
Security resetCanCusipTo: string

Description:

Delete the recipient's current canadian cusip and set the 'canCusip' to the supplied value. The current value is removed from the Named Security, Named Company, and XRef CanCusip dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o resetCodeTo:

Synopsis:
Security resetCodeTo: string

Description:

Change the recipient's 'code' to the supplied string. If the recipient's company code was the same as the recipient's code, it is changed to the supplied string as well.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o resetCompany

Synopsis:
Security resetCompany

Description:

Resets recipient's 'company' to the default.

Type: Method          Function: Update          Level: DBA

Returns: Security

o resetCusipTo:

Synopsis:
Security resetCusipTo: string

Description:

Delete the recipient's current cusip and set the 'cusip' to the supplied value. The current value is removed from the Named Security, Named Company, and XRef Cusip dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o resetIsinTo:

Synopsis:
Security resetIsinTo: string

Description:

Delete the recipient's current isin and set the 'cusip' to the supplied value. The current value is removed from the Named Security, Named Company, and XRef Isin dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o resetSedolTo:

Synopsis:
Security resetSedolTo: string

Description:

Delete the recipient's current sedol and set the 'sedol' to the supplied value. The current value is removed from the Named Security, Named Company, and XRef Sedol dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o resetValorTo:

Synopsis:
Security resetValorTo: string

Description:

Delete the recipient's current valor and set the 'valor' to the supplied value. The current value is removed from the Named Security, Named Company, and XRef Valor dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o sedol

Synopsis:
Security sedol

Description:

Sedol identifier.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o sedol6

Synopsis:
Security sedol6

Description:

First 6 characters of sedol.

Type: Method          Function: Data          Level: Basic

Returns: String

o setCanCusipTo:

Synopsis:
Security setCanCusipTo: string

Description:

Sets the recipient's 'canCusip' to supplied string. If the current 'code' is the same as the old 'canCusip', it is reset to the supplied string as well. The string is added as an alias to the Named Security and Named Company dictionaries (with a prepended 'c') and to the XRef CanCusip (as an 8 and 9 character id).

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setCompanyTo:

Synopsis:
Security setCompanyTo: comp

Description:

Set company for recipient. Note that security/company pairs that are created together with 'createAndLink:' will have identical 'code' value and should not be reset because you will lose aliases at the company. The recipient's aliases that are associated with the original company are deleted from this company and added to the supplied company. If the supplied company does not refer to a primary security, its 'primarySecurity' is set to recipient.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - Company

o setCusipTo:

Synopsis:
Security setCusipTo: string

Description:

Sets the recipient's 'cusip' to supplied string. If the current 'code' is the same as the old 'cusip', it is reset to the supplied string as well. The string is added as an alias to the Named Security and Named Company dictionaries and to the XRef Cusip (as an 8 and 9 character id).

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setIsinTo:

Synopsis:
Security setIsinTo: string

Description:

Sets the recipient's 'isin' to supplied string. If the current 'code' is the same as the old 'isin', it is reset to the supplied string as well. The string is added as an alias to the Named Security and Named Company dictionaries and to the XRef Isin.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setNameTo:

Synopsis:
Entity setNameTo: string

Description:

Updates recipient's 'name' property with supplied string.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String

o setNumericCodeTo:

Synopsis:
Entity setNumericCodeTo: string

Description:

Updates recipient's 'numericCode' property with supplied number.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - Number

o setSedolTo:

Synopsis:
Security setSedolTo: string

Description:

Sets the recipient's 'sedol' to supplied string. If the current 'code' is the same as the old 'sedol', it is reset to the supplied string as well. The string is added as an alias to the Named Security and Named Company dictionaries and to the XRef Sedol (6 and 7 character sedol id).

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setShortNameTo:

Synopsis:
Entity setShortNameTo: string

Description:

Updates recipient's 'shortName' property with string.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String

o setSortCodeTo:

Synopsis:
Entity setSortCodeTo: string

Description:

Updates recipient's 'sortCode' property with string.

Type: Method          Function: Update          Level: DBA

Returns: Entity

Parameters:

1 - String

o setTickerTo:

Synopsis:
Security setTickerTo: string

Description:

Sets the recipient's 'ticker' to supplied string. The string is added as an alias to the Named Security and Named Company dictionaries.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setTypeTo:

Synopsis:
Security setTypeTo: sectype

Description:

Sets recipient's 'type' property to the supplied SecurityType.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - SecurityType

o setValorTo:

Synopsis:
Security setValorTo: string

Description:

Sets the recipient's 'valor' to supplied string. If the current 'code' is the same as the old 'valor', it is reset to the supplied string as well. The string is added as an alias to the Named Security and Named Company dictionaries (prepended with 'v') and to the XRef Valor.

Type: Method          Function: Update          Level: DBA

Returns: Security

Parameters:

1 - String

o setXRefIn:to:

Synopsis:
Entity setXRefIn: dictionary to: string

Description:

Sets the supplied string in the supplied XRef dictionary to return recipient.

Type: Method          Function: Schema          Level: DBA

Returns: Entity

Parameters:

1 - XRef
2 - String

o sharesOut

Synopsis:
Security sharesOut

Description:

Latest shares outstanding on or before ^date (adjusted for splits).

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

Returns: Number

o shortName

Synopsis:
Entity shortName

Description:

Short name. This is the same as 'code' by default.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o sortCode

Synopsis:
Entity sortCode

Description:

Code that can be used to sort instances. This is the same as 'code' by default.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o 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: DBA

Returns: Entity

Parameters:

1 - String
2 - Object

o ticker

Synopsis:
Security ticker

Description:

Ticker symbol.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o totalReturnFrom:to:

Synopsis:
Security totalReturnFrom: date1 to: date2

Description:

Total return between supplied dates. This value is computed using starting and ending price and the dividends in the period.

Type: Method          Function: Data          Level: Basic

Returns: Number

Parameters:

1 - Date
2 - Date

o type

Synopsis:
Security type

Description:

Security type.

Type: FixedProperty          Function: Data          Level: Basic

Returns: SecurityType

o universes

Synopsis:
Entity universes

Description:

List of Universe in which recipient is a member.

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

Returns: List of Universe

o updateInitializationListWith:

Synopsis:
Entity updateInitializationListWith: block

Description:

Adds the supplied block to the recipient class' initializationList.

Type: Method          Function: Schema          Level: DBA

Returns: Entity

Parameters:

1 - Block

o validateInputString:

Synopsis:
Entity validateInputString: input

Description:

Instance in recipient's class associated with the supplied string. If not found, NA is returned.

Type: Method          Function: Access          Level: Basic

Returns: Entity

Parameters:

1 - String

o valor

Synopsis:
Security valor

Description:

Valor identifier.

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

o volume

Synopsis:
Security volume

Description:

Lates trading volume on or before ^date.

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

Returns: Number

o whatAmI

Synopsis:
Entity whatAmI

Description:

Return the string "Entity".

Type: Constant          Function: Descriptive          Level: Basic

Returns: String

o whatAmI

Synopsis:
Security whatAmI

Description:

Returns the string "Security".

Type: Constant          Function: Schema          Level: Basic

Returns: String