Vision Messages: Company

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

Profile of Class Company

Includes Classes: Company, Entity


Object
  | 
Entity
  | 
  +--- Company

This class represents corporate entities. Information maintained for a company typically includes country, industry, sales, and earnings. One or more securities may be issued by a company.

Message Index

XRef (Entity)
XRef (Company)
accessExpression (Entity)
addAlias: alias (Entity)
addAlias: string toXRefIn: dictionary (Entity)
adjustmentRelativeTo: aDate (Company)
aliases (Entity)
asSelf (Entity)
asSelf (Company)
classDescriptor (Entity)
classDescriptor (Company)
cleanupClassStructures (Entity)
cleanupClassStructures (Company)
cleanupLocalNames (Entity)
clusterStrings (Entity)
country (Company)
createInitializationListFrom: initList (Entity)
createNewXRefManager (Entity)
createPrivateStructure (Entity)
createXRef: id withProperty: propertyId (Entity)
cusip (Company)
cusip6 (Company)
defaultInstance (Entity)
defaultInstance (Company)
deleteAlias: aliasList (Entity)
displayInfo (Entity)
displayInfo (Company)
displayLabel (Entity)
displayLabelKey (Entity)
displayXRefAuditReport (Entity)
fiscalYearEnd (Company)
getAdjustedDataFor: aTimeSeries (Company)
getAdjustedSharesDataFor: aTimeSeries (Company)
getOrCreate: key (Entity)
getRecordForUser: userName (Entity)
helpMessage (Entity)
id (Company)
industry (Company)
initializationList (Entity)
initializationList (Company)
initialize (Entity)
initialize (Company)
initializeDataBaseLinks (Entity)
initializeGlobalInstanceProperties (Entity)
initializeGlobalSubclassProperties (Entity)
initializeLocalAttributes (Entity)
isCompany (Company)
isEntity (Entity)
isMemberOf: universe (Entity)
isin (Company)
locateId: id (Entity)
locateIds: string (Entity)
masterListCodes (Entity)
name (Entity)
named (Entity)
named (Company)
newAs: string (Entity)
numericCode (Entity)
primarySecurity (Company)
print (Entity)
print: aFormat (Entity)
profile (Entity)
profile (Company)
rebuildAliases (Entity)
rebuildCusipIssuerXRef (Company)
rebuildSecurityList (Company)
resetPrimarySecurity (Company)
sector (Company)
securityList (Company)
sedol (Company)
setFiscalYearEndTo: fyr (Company)
setNameTo: string (Entity)
setNumericCodeTo: string (Entity)
setPrimarySecurityTo: sec (Company)
setShortNameTo: string (Entity)
setSortCodeTo: string (Entity)
setXRefIn: dictionary to: string (Entity)
shortName (Entity)
sortCode (Entity)
specializeAs: string at: object (Entity)
ticker (Company)
universes (Entity)
updateInitializationListWith: block (Entity)
validateInputString: input (Entity)
valor (Company)
whatAmI (Entity)
whatAmI (Company)

Messages

XRef

Synopsis:
Entity XRef

Description:
Provides cross reference for alternative identifiers.

Type: Constant Function: Schema Level: DBA
Returns: XRef

XRef

Synopsis:
Company XRef

Description:
Provides cross reference for alternative identifiers.

Type: Constant Function: Schema Level: DBA
Returns: Company XRef

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

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

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

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

adjustmentRelativeTo:

Synopsis:
Company 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

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

asSelf

Synopsis:
Entity asSelf

Description:
Recipient stripped of any extensions.

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

asSelf

Synopsis:
Company asSelf

Description:
Recipient stripped of any extensions.

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

classDescriptor

Synopsis:
Entity classDescriptor

Description:
Class descriptor for recipient's class.

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

classDescriptor

Synopsis:
Company 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: DBA
Returns: NoValue

cleanupClassStructures

Synopsis:
Company 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 used to remove aliases from the appropriate naming dictionaries.

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

clusterStrings

Synopsis:
Entity clusterStrings

Description:
Reclusters string property values.

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

country

Synopsis:
Company country

Description:
Principal country of business.

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

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

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

createPrivateStructure

Synopsis:
Entity createPrivateStructure

Description:
Creates private extension of recipient's class.

Type: Method Function: Schema Level: DBA
Returns: PrivateRecord

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

cusip

Synopsis:
Company cusip

Description:
Cusip associated with primary security.

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

cusip6

Synopsis:
Company cusip6

Description:
6-character issuer id (domestic companies).

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

defaultInstance

Synopsis:
Entity defaultInstance

Description:
Returns the default Entity instance.

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

defaultInstance

Synopsis:
Company defaultInstance

Description:
Returns the default Company instance.

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

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

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

displayInfo

Synopsis:
Company displayInfo

Description:
One line display of code, ticker, and name.

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

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

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

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

fiscalYearEnd

Synopsis:
Company fiscalYearEnd

Description:
Month of fiscal year end (1 - 12).

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

getAdjustedDataFor:

Synopsis:
Company 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

getAdjustedSharesDataFor:

Synopsis:
Company 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

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

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

helpMessage

Synopsis:
Entity helpMessage

Description:
Returns a message describing the recipient.

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

Synopsis:
Company id

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

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

industry

Synopsis:
Company industry

Description:
Primary industry.

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

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

initializationList

Synopsis:
Company 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 properties in newly created instance.

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

initialize

Synopsis:
Company initialize

Description:
Initializes properties in newly created instance.

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

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

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

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

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

isCompany

Synopsis:
Company isCompany

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

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

isin

Synopsis:
Company isin

Description:
Isin code associated with primary security.

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

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

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

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

name

Synopsis:
Entity name

Description:
recipient's name.

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

named

Synopsis:
Entity named

Description:
Naming dictionary for recipient's class.

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

named

Synopsis:
Company 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: DBA
Returns: Entity
Parameters:
1 - String

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

primarySecurity

Synopsis:
Company primarySecurity

Description:
Primary security issued by recipient. This is usually the common stock security.

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

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

print:

Synopsis:
Entity print: aFormat

Description:
Prints recipient's 'code' using supplied format.

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

profile

Synopsis:
Entity profile

Description:
Displays a multi-line description of recipient.

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

profile

Synopsis:
Company profile

Description:
Basic descriptive report about the recipient.

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

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

rebuildCusipIssuerXRef

Synopsis:
Company rebuildCusipIssuerXRef

Description:
Rebuilds the CusipIssuer XRef using the 6 character issuer id (cusip6) if available. This message is executed for the entire company class and is normally sent to the default instance.

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

rebuildSecurityList

Synopsis:
Company rebuildSecurityList

Description:
Rebuilds the 'securityList' for all companies. This message is executed for the entire company class and is normally sent to the default instance.

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

resetPrimarySecurity

Synopsis:
Company resetPrimarySecurity

Description:
Resets the primary security to the default Security for the recipient.

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

sector

Synopsis:
Company sector

Description:
Sector associated with the recipient's industry.

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

securityList

Synopsis:
Company securityList

Description:
List of securities issued by recipient. This list is updated as part of a batch process and will not reflect securities that have been manually assigned to this company.

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

sedol

Synopsis:
Company sedol

Description:
Sedol associated with primary security.

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

setFiscalYearEndTo:

Synopsis:
Company setFiscalYearEndTo: fyr

Description:
Sets the 'fiscalYearEnd' to supplied parameter. The parameter should be a number from 1 - 12 indicating the month in which the fiscal year ends.

Type: Method Function: Update Level: DBA
Returns: Company
Parameters:
1 - Integer

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

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

setPrimarySecurityTo:

Synopsis:
Company setPrimarySecurityTo: sec

Description:
Updates the 'primarySecurity' property.

Type: Method Function: Update Level: DBA
Returns: Company
Parameters:
1 - Security

setShortNameTo:

Synopsis:
Entity setShortNameTo: string

Description:
Updates recipient's 'shortName' property with string.

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

setSortCodeTo:

Synopsis:
Entity setSortCodeTo: string

Description:
Updates recipient's 'sortCode' property with string.

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

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

shortName

Synopsis:
Entity shortName

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

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

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

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

ticker

Synopsis:
Company ticker

Description:
Ticker symbol associated with primary security.

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

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

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

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

valor

Synopsis:
Company valor

Description:
Valor number associated with primary security.

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

whatAmI

Synopsis:
Entity whatAmI

Description:
Return the string "Entity".

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

whatAmI

Synopsis:
Company whatAmI

Description:
Returns the string "Company".

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