Vision Messages: Entity
Object | +--- Entity | | | +--- Classification | | | | | +--- RangeClassification | | | +--- Currency | | | +--- DataSource | | | +--- Support | | | +--- SystemTable | | | | | +--- ClassType | | | | | +--- FunctionType | | | | | +--- MessageType | | | | | +--- UpdateType | | | | | +--- UsageLevel | | | +--- Table
The Entity subclasses are defined to describe real-world entities such as companies, industries, countries, and products. Instances of the entity subclasses are often named and can be referenced directly or used as part of a list. Tables are often created as subclasses of Entity.
Message Index
XRef
accessExpression
addAlias: string
addAlias: string toXRefIn: dictionary
aliases
asSelf
classDescriptor
cleanupClassStructures
cleanupLocalNames
clusterStrings
createInitializationListFrom: blockList
createNewXRefManager
createPrivateStructure
createXRef: id withProperty: propertyId
defaultInstance
deleteAlias: aliasList
displayInfo
displayLabel
displayLabelKey
displayXRefAuditReport
getOrCreate: string
getRecordForUser: userName
helpMessage
initializationList
initialize
initializeDataBaseLinks
initializeGlobalInstanceProperties
initializeGlobalSubclassProperties
initializeLocalAttributes
isEntity
loadFromFile: file
loadValuesFor: item as: type fromFile: file
locateId: string
locateIds: string
masterListCodes
name
named
newAs: string
numericCode
print
print: anInteger
profile
rebuildAliases
setNameTo: string
setNumericCodeTo: ordinal
setShortNameTo: string
setSortCodeTo: ordinal
setXRefIn: dictionary to: string
shortName
sortCode
specializeAs: string at: object
updateInitializationListWith: block
validateInputString: input
whatAmI
Messages
Synopsis:Entity XRefType: Constant Returns: XRef
Also Defined At:
| Currency |

Synopsis:Entity accessExpressionDescription:
Returns a string that could be used to request recipientType: Method Returns: String
Also Defined At:
| Object |

Synopsis:Entity addAlias: stringDescription:
Adds supplied string as alternate name in recipient's naming dictionary.Type: Method Returns: Entity
Parameters:
1 - String

Synopsis:Entity addAlias: string toXRefIn: dictionaryType: Method Returns: Object

Synopsis:Entity aliasesDescription:
Returns list of aliases named for entity.Type: FixedProperty Returns: List

Synopsis:Entity asSelfDescription:
Returns the original object.Type: Primitive Returns: Entity
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

Synopsis:Entity classDescriptorDescription:
Reference to the object which describes the class. Class level information is stored here.Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

Synopsis:Entity cleanupClassStructuresDescription:
Runs 'cleanStoreAndDictionary' at Object, this method is redefined as needed by subclasses to perform general cleanup functions.Type: Method Returns: Object
Also Defined At:
| Dictionary | Object |

Synopsis:Entity cleanupLocalNamesDescription:
This method is executed by the 'flagForDeletionWithReason:' message and is redefined as needed by subclasses.Type: Method Returns: Object
Also Defined At:
| Object |

Synopsis:Entity clusterStringsType: Method Returns: Object

Synopsis:Entity createInitializationListFrom: blockListDescription:
Creates a new class constant for the recipient's class named 'initializationList' and copies the blocks in blockList to this list. The initializationList is used during the instance creation process to initialize default values in the new instance.Type: Method Returns: Entity
Parameters:
1 - List

Synopsis:Entity createNewXRefManagerType: Method Returns: Object

Synopsis:Entity createPrivateStructureType: Method Returns: Object

Synopsis:Entity createXRef: id withProperty: propertyIdType: Method Returns: Object

Synopsis:Entity defaultInstanceDescription:
Returns the default instance of the recipient object's classType: Constant Returns: Entity
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

Synopsis:Entity deleteAlias: aliasListType: Method Returns: Object

Synopsis:Entity displayInfoDescription:
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 Returns: Object
Also Defined At:
| Object |

Synopsis:Entity displayLabelDescription:
Returns the recipient's nameType: Method Returns: Object
Also Defined At:
| Object |

Synopsis:Entity displayLabelKeyDescription:
Returns the recipient's codeType: Method Returns: Object
Also Defined At:
| Object |

Synopsis:Entity displayXRefAuditReportType: Method Returns: Object

Synopsis:Entity getOrCreate: stringDescription:
Returns object named by string in recipient class' naming dictionary. If not found, a new instance is created and returned.Type: Method Returns: Entity
Parameters:
1 - String

Synopsis:Entity getRecordForUser: userNameType: Method Returns: Object

Synopsis:Entity helpMessageDescription:
Returns a message describing the recipient.Type: Method Returns: String
Also Defined At:
| Object |

Synopsis:Entity initializationListDescription:
Returns the list of blocks used to initialize default values in new instances of the recipient's class.Type: Constant Returns: List

Synopsis:Entity initializeDescription:
Initializes a new instance. Run as part of the instance creation process.Type: Method Returns: Entity
Also Defined At:
| Currency | Dictionary |

Synopsis:Entity initializeDataBaseLinksDescription:
Initializes a new instance. Run as part of the instance creation process.Type: Method Returns: Entity

Synopsis:Entity initializeGlobalInstancePropertiesDescription:
Initializes a new instance. Run as part of the instance creation process.Type: Method Returns: Entity
Also Defined At:
| Classification | Object |

Synopsis:Entity initializeGlobalSubclassPropertiesDescription:
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 Returns: Object
Also Defined At:
| Dictionary | Object |

Synopsis:Entity initializeLocalAttributesDescription:
Initializes a new instance. Run as part of the instance creation process.Type: Method Returns: Entity
Also Defined At:
| Dictionary | Object |

Synopsis:Entity isEntityDescription:
Returns the value TRUE when sent to any Entity.Type: Constant Returns: TRUE
Also Defined At:
| Object |

Synopsis:Entity loadFromFile: fileType: Method Returns: Object

Synopsis:Entity loadValuesFor: item as: type fromFile: fileType: Method Returns: Object

Synopsis:Entity locateId: stringDescription:
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 Returns: Entity
Parameters:
1 - String

Synopsis:Entity locateIds: stringType: Method Returns: Object

Synopsis:Entity masterListCodesDescription:
Displays all codes and names for all non-default instances in recipient's class.Type: Method Returns: Object

Synopsis:Entity nameDescription:
Returns descriptive name for recipient.Type: FixedProperty Returns: String

Synopsis:Entity namedDescription:
Returns the naming dictionary for the recipient's class.Type: Constant Returns: Dictionary
Also Defined At:
| Classification | Currency |

Synopsis:Entity newAs: stringDescription:
Special version of 'newAs:' message designed to address the additional requirements of entity instance creation.Type: Method Returns: Entity
Also Defined At:
| Dictionary | Object |

Synopsis:Entity numericCodeDescription:
Returns descriptive numeric code for recipient.Type: FixedProperty Returns: String

Synopsis:Entity printDescription:
Redefines the standard print message so that the value of the recipient code is printed.Type: Method Returns: Entity
Also Defined At:
| Block | Date | DateOffset | DateRange | IndexedList | List | Object | String | TimeSeries | Undefined |

Synopsis:Entity print: anIntegerDescription:
Prints the recipient code using the supplied format.Type: Method Returns: Entity
Parameters:
1 - Integer
Also Defined At:
| Boolean | Date | Number | Object | String | Undefined |

Synopsis:Entity profileDescription:
Displays a multi-line description of the recipient object.Type: Method Returns: Object

Synopsis:Entity rebuildAliasesType: Method Returns: Object

Synopsis:Entity setNameTo: stringDescription:
Updates the value of the recipient's 'name' property with stringType: Method Returns: Entity
Parameters:
1 - String

Synopsis:Entity setNumericCodeTo: ordinalDescription:
Updates the value of the recipient's 'numericCode' property with string or number. Used as an alternative identification scheme.Type: Method Returns: Entity
Parameters:
1 - Ordinal

Synopsis:Entity setShortNameTo: stringDescription:
Updates the value of the recipient's 'shortName' property with string.Type: Method Returns: Entity
Parameters:
1 - String

Synopsis:Entity setSortCodeTo: ordinalDescription:
Updates the value of the recipient's 'sortCode' property with string or number. Used as an alternative identification scheme.Type: Method Returns: Entity
Parameters:
1 - Ordinal

Synopsis:Entity setXRefIn: dictionary to: stringType: Method Returns: Object

Synopsis:Entity shortNameDescription:
Returns descriptive shortName for recipient.Type: FixedProperty Returns: String

Synopsis:Entity sortCodeDescription:
Returns descriptive sortCode for recipient.Type: FixedProperty Returns: String

Synopsis:Entity specializeAs: string at: objectDescription:
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 defaultType: Method Returns: Object
Also Defined At:
| Object |

Synopsis:Entity updateInitializationListWith: blockDescription:
Adds the supplied block to the recipient class' initializationList.Type: Method Returns: Entity
Parameters:
1 - Block

Synopsis:Entity validateInputString: inputDescription:
Returns the object in the recipient's classs associated with the supplied string, using the recipient's class naming dictionary.Type: Method Returns: Object
Also Defined At:
| Object |

Synopsis:Entity whatAmIDescription:
Return the string "Entity".Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |