Vision Messages: Classification

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

Profile of Class Classification

Includes Classes: AssetCategory, Classification, Country, Entity, Industry, RangeClassification, Sector, SecurityType 


Object
  | 
Entity
  | 
  +--- Classification
  |      |
  |      +--- AssetCategory
  |      |
  |      +--- Country
  |      |
  |      +--- Industry
  |      |
  |      +--- RangeClassification
  |      |
  |      +--- Sector
  |      |
  |      +--- SecurityType

This abstract class is a subclass of Entity and a superclass of classes used primarily for grouping and aggregation purposes.

Message Index

o XRef (Entity)
o accessExpression (Entity)
o addAlias: alias (Entity)
o addAlias: string toXRefIn: dictionary (Entity)
o aliases (Entity)
o asSelf (Entity)
o asSelf (Classification)
o asSelf (RangeClassification)
o asSelf (Country)
o asSelf (Industry)
o asSelf (Sector)
o asSelf (SecurityType)
o asSelf (AssetCategory)
o childList (Classification)
o classDescriptor (Entity)
o classDescriptor (Classification)
o classDescriptor (RangeClassification)
o classDescriptor (Country)
o classDescriptor (Industry)
o classDescriptor (Sector)
o classDescriptor (SecurityType)
o classDescriptor (AssetCategory)
o cleanupClassStructures (Entity)
o cleanupLocalNames (Entity)
o clusterStrings (Entity)
o companyList (Country)
o companyList (Industry)
o companyList (Sector)
o createInitializationListFrom: initList (Entity)
o createNewXRefManager (Entity)
o createPrivateStructure (Entity)
o createXRef: id withProperty: propertyId (Entity)
o defaultInstance (Entity)
o defaultInstance (Classification)
o defaultInstance (RangeClassification)
o defaultInstance (Country)
o defaultInstance (Industry)
o defaultInstance (Sector)
o defaultInstance (SecurityType)
o defaultInstance (AssetCategory)
o deleteAlias: aliasList (Entity)
o displayHierarchy (Classification)
o displayInfo (Entity)
o displayLabel (Entity)
o displayLabelKey (Entity)
o displayMemberHistory (Classification)
o displayXRefAuditReport (Entity)
o getAllChildren (Classification)
o getAllCompanies (Industry)
o getAllMembers (Classification)
o getClassificationFor: input (RangeClassification)
o getOrCreate: key (Entity)
o getRecordForUser: userName (Entity)
o helpMessage (Entity)
o includesElement: entity (Classification)
o industryList (Sector)
o initializationList (Entity)
o initializationList (Country)
o initialize (Entity)
o initializeDataBaseLinks (Entity)
o initializeGlobalInstanceProperties (Entity)
o initializeGlobalInstanceProperties (Classification)
o initializeGlobalSubclassProperties (Entity)
o initializeKeys: keys (RangeClassification)
o initializeLocalAttributes (Entity)
o isAssetCategory (AssetCategory)
o isCanada (Country)
o isCashEquiv (SecurityType)
o isClassification (Classification)
o isCountry (Country)
o isEntity (Entity)
o isEquity (SecurityType)
o isFixed (SecurityType)
o isIndustry (Industry)
o isMemberOf: universe (Entity)
o isOther (SecurityType)
o isParent (Classification)
o isRangeClassification (RangeClassification)
o isSector (Sector)
o isSecurityType (SecurityType)
o isUS (Country)
o isUSA (Country)
o locateId: id (Entity)
o locateIds: string (Entity)
o lowerBound (RangeClassification)
o masterListCodes (Entity)
o memberList (Classification)
o name (Entity)
o named (Entity)
o named (Classification)
o named (RangeClassification)
o named (Country)
o named (Industry)
o named (Sector)
o named (SecurityType)
o named (AssetCategory)
o newAs: string (Entity)
o numericCode (Entity)
o parent (Classification)
o print (Entity)
o print: aFormat (Entity)
o profile (Entity)
o rangeName (RangeClassification)
o rebuildAliases (Entity)
o sector (Industry)
o setNameTo: string (Entity)
o setNumericCodeTo: string (Entity)
o setParentTo: p (Classification)
o setShortNameTo: string (Entity)
o setSortCodeTo: string (Entity)
o setXRefIn: dictionary to: string (Entity)
o shortName (Entity)
o sortCode (Entity)
o specializeAs: string at: object (Entity)
o unitCalc (SecurityType)
o universes (Entity)
o updateInitializationListWith: block (Entity)
o upperBound (RangeClassification)
o validateInputString: input (Entity)
o whatAmI (Entity)
o whatAmI (Classification)
o whatAmI (RangeClassification)
o whatAmI (Country)
o whatAmI (Industry)
o whatAmI (Sector)
o whatAmI (SecurityType)
o whatAmI (AssetCategory)

Messages

o XRef

Synopsis:
Entity XRef

Description:

Provides cross reference for alternative identifiers.

Type: Constant          Function: Schema          Level: DBA

Returns: XRef

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: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 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:
Classification asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Classification

o asSelf

Synopsis:
RangeClassification asSelf

Description:

Returns the original object, stripped of extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Object

o asSelf

Synopsis:
Country asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Country

o asSelf

Synopsis:
Industry asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Industry

o asSelf

Synopsis:
Sector asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: Sector

o asSelf

Synopsis:
SecurityType asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: SecurityType

o asSelf

Synopsis:
AssetCategory asSelf

Description:

Recipient stripped of any extensions.

Type: Primitive          Function: Conversion          Level: Basic

Returns: AssetCategory

o childList

Synopsis:
Classification childList

Description:

List of instances of recipient's class that have recipient as a direct parent.

Type: FixedProperty          Function: Data          Level: Basic

Returns: IndexedList of Classification

o classDescriptor

Synopsis:
Entity classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Classification classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
RangeClassification classDescriptor

Description:

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

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Country classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Industry classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
Sector classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
SecurityType classDescriptor

Description:

Class descriptor for recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Schema ClassDescriptor

o classDescriptor

Synopsis:
AssetCategory 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 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 clusterStrings

Synopsis:
Entity clusterStrings

Description:

Reclusters string property values.

Type: Method          Function: DBAdamin          Level: DBA

Returns: NoValue

o companyList

Synopsis:
Country companyList

Description:

List of companies in country (same as 'memberList').

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

Returns: IndexedList of Company

o companyList

Synopsis:
Industry companyList

Description:

List of companies in recipient (same as 'memberList').

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

Returns: IndexedList of Company

o companyList

Synopsis:
Sector companyList

Description:

List of all companies in the 'memberList' of the industries in recpient's 'memberList'.

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

Returns: List of Company

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 defaultInstance

Synopsis:
Entity defaultInstance

Description:

Returns the default Entity instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Entity

o defaultInstance

Synopsis:
Classification defaultInstance

Description:

Returns the default Classification instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Classification

o defaultInstance

Synopsis:
RangeClassification defaultInstance

Description:

Returns the default instance for the recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: RangeClassification

o defaultInstance

Synopsis:
Country defaultInstance

Description:

Returns the default Country instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Country

o defaultInstance

Synopsis:
Industry defaultInstance

Description:

Returns the default Industry instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Industry

o defaultInstance

Synopsis:
Sector defaultInstance

Description:

Returns the default Sector instance.

Type: Constant          Function: Schema          Level: Basic

Returns: Sector

o defaultInstance

Synopsis:
SecurityType defaultInstance

Description:

Returns the default SecurityType instance.

Type: Constant          Function: Schema          Level: Basic

Returns: SecurityType

o defaultInstance

Synopsis:
AssetCategory defaultInstance

Description:

Returns the default AssetCategory instance.

Type: Constant          Function: Schema          Level: Basic

Returns: AssetCategory

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 displayHierarchy

Synopsis:
Classification displayHierarchy

Description:

Displays recipient's parent hierarchy.

Type: Method          Function: Display          Level: Basic

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 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 displayMemberHistory

Synopsis:
Classification displayMemberHistory

Description:

Displays history of changes to the 'memberList' property.

Type: Method          Function: Display          Level: Basic

Returns: NoValue

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 getAllChildren

Synopsis:
Classification getAllChildren

Description:

List of instances of recipient's class that have recipient as a direct or indirect parent.

Type: Method          Function: Data          Level: Basic

Returns: List of Classification

o getAllCompanies

Synopsis:
Industry getAllCompanies

Description:

List of all companies in recipient's 'memberList' or the 'memberList' of any of its direct or indirect children.

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

Returns: List of Company

o getAllMembers

Synopsis:
Classification getAllMembers

Description:

List of members in 'memberList' for recipient and all direct and indirect children of recipient.

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

Returns: List of Entity

o getClassificationFor:

Synopsis:
RangeClassification getClassificationFor: input

Type: Method          Function: Data          Level: Basic

Returns: RangeClassification

Parameters:

1 - Number

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 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 helpMessage

Synopsis:
Entity helpMessage

Description:

Returns a message describing the recipient.

Type: Method          Function: Descriptive          Level: Basic

Returns: String

o includesElement:

Synopsis:
Classification includesElement: entity

Description:

Returns TRUE if recipient's 'memberList' includes supplied entity.

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

Parameters:

1 - Entity

o industryList

Synopsis:
Sector industryList

Description:

List of industries in recpient (same as 'memberList').

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

Returns: IndexedList of Industry

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:
Country 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 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 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 initializeGlobalInstanceProperties

Synopsis:
Classification initializeGlobalInstanceProperties

Description:

This method is run as part of the 'new' method and is used to initialize properties in the new instance.

Type: Method          Function: Creation          Level: Basic

Returns: Classification

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

Synopsis:
RangeClassification initializeKeys: keys

Description:

This method is run as part of the 'createInstance:' process. A single string representing the code of the new object is supplied. Many classes redefine this message to require a list of keys as a parameter.

Type: Method          Function: Creation          Level: Basic

Returns: Object

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 isAssetCategory

Synopsis:
AssetCategory isAssetCategory

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isCanada

Synopsis:
Country isCanada

Description:

Is recpient the country 'Canada'?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isCashEquiv

Synopsis:
SecurityType isCashEquiv

Description:

Is recpient's 'assetCategory' cash?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isClassification

Synopsis:
Classification isClassification

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isCountry

Synopsis:
Country isCountry

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isEntity

Synopsis:
Entity isEntity

Description:

Returns the value TRUE when sent to any Entity.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isEquity

Synopsis:
SecurityType isEquity

Description:

Is recpient's 'assetCategory' equity?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isFixed

Synopsis:
SecurityType isFixed

Description:

Is recpient's 'assetCategory' fixed income?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isIndustry

Synopsis:
Industry isIndustry

Description:

Returns the value TRUE.

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 isOther

Synopsis:
SecurityType isOther

Description:

Is recpient's 'assetCategory' other?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isParent

Synopsis:
Classification isParent

Description:

Returns TRUE if recipient is its own parent. (TRUE by default).

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isRangeClassification

Synopsis:
RangeClassification isRangeClassification

Type: Constant          Function: Not Defined          Level: Basic

Returns: TRUE

o isSector

Synopsis:
Sector isSector

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isSecurityType

Synopsis:
SecurityType isSecurityType

Description:

Returns the value TRUE.

Type: Constant          Function: Inquiry          Level: Basic

Returns: TRUE

o isUS

Synopsis:
Country isUS

Description:

Is recpient the country 'United States'?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

o isUSA

Synopsis:
Country isUSA

Description:

Is recpient the country 'United States'?

Type: Method          Function: Inquiry          Level: Basic

Returns: Boolean

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 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 lowerBound

Synopsis:
RangeClassification lowerBound

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

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 memberList

Synopsis:
Classification memberList

Description:

Member entities associated with recipient.

Type: TimeSeriesProperty          Function: Data          Level: Basic

Returns: IndexedList of Entity

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:
Classification named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o named

Synopsis:
RangeClassification named

Description:

Returns the naming dictionary for the recipient's class.

Type: Constant          Function: Descriptive          Level: Basic

Returns: Named

o named

Synopsis:
Country named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o named

Synopsis:
Industry named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o named

Synopsis:
Sector named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o named

Synopsis:
SecurityType named

Description:

Naming dictionary associated with recipient's class.

Type: Constant          Function: Schema          Level: Basic

Returns: Named

o named

Synopsis:
AssetCategory 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 parent

Synopsis:
Classification parent

Description:

Recipient's parent object. This is an instance of the recipient's class and is the recipient by default. This property is used to construct classification hierarchies.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Classification

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 rangeName

Synopsis:
RangeClassification rangeName

Type: FixedProperty          Function: Data          Level: Basic

Returns: String

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 sector

Synopsis:
Industry sector

Description:

Sector associated with recipient.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Sector

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

Synopsis:
Classification setParentTo: p

Description:

Reassign the parent object to another instance of recipient's class. By default, the recipient is its own parent.

Type: Method          Function: Update          Level: DBA

Returns: Classification

Parameters:

1 - Classification

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 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 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 unitCalc

Synopsis:
SecurityType unitCalc

Description:

Mutliplier for adjusting units of security held for market value calculation purposes.

Type: FixedProperty          Function: Data          Level: Basic

Returns: Double

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 upperBound

Synopsis:
RangeClassification upperBound

Type: FixedProperty          Function: Data          Level: Basic

Returns: Number

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 whatAmI

Synopsis:
Entity whatAmI

Description:

Return the string "Entity".

Type: Constant          Function: Descriptive          Level: Basic

Returns: String

o whatAmI

Synopsis:
Classification whatAmI

Description:

Returns the string "Classification".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
RangeClassification whatAmI

Description:

Returns the name of the recipient's class.

Type: Constant          Function: Descriptive          Level: Basic

Returns: String

o whatAmI

Synopsis:
Country whatAmI

Description:

Returns the string "Country".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
Industry whatAmI

Description:

Returns the string "Industry".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
Sector whatAmI

Description:

Returns the string "Sector".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
SecurityType whatAmI

Description:

Returns the string "SecurityType".

Type: Constant          Function: Schema          Level: Basic

Returns: String

o whatAmI

Synopsis:
AssetCategory whatAmI

Description:

Returns the string "AssetCategory".

Type: Constant          Function: Schema          Level: Basic

Returns: String