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

XRef

Synopsis:
Entity XRef

Type: Constant Returns: XRef
Also Defined At:
| Currency |

accessExpression

Synopsis:
Entity accessExpression

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

Type: Method Returns: String
Also Defined At:
| Object |

addAlias:

Synopsis:
Entity addAlias: string

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

Type: Method Returns: Entity
Parameters:
1 - String

addAlias:toXRefIn:

Synopsis:
Entity addAlias: string toXRefIn: dictionary

Type: Method Returns: Object

aliases

Synopsis:
Entity aliases

Description:
Returns list of aliases named for entity.

Type: FixedProperty Returns: List

asSelf

Synopsis:
Entity asSelf

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

classDescriptor

Synopsis:
Entity classDescriptor

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

cleanupClassStructures

Synopsis:
Entity cleanupClassStructures

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

cleanupLocalNames

Synopsis:
Entity cleanupLocalNames

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

Type: Method Returns: Object
Also Defined At:
| Object |

clusterStrings

Synopsis:
Entity clusterStrings

Type: Method Returns: Object

createInitializationListFrom:

Synopsis:
Entity createInitializationListFrom: blockList

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

Type: Method Returns: Entity
Parameters:
1 - List

createNewXRefManager

Synopsis:
Entity createNewXRefManager

Type: Method Returns: Object

createPrivateStructure

Synopsis:
Entity createPrivateStructure

Type: Method Returns: Object

createXRef:withProperty:

Synopsis:
Entity createXRef: id withProperty: propertyId

Type: Method Returns: Object

defaultInstance

Synopsis:
Entity defaultInstance

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

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

deleteAlias:

Synopsis:
Entity deleteAlias: aliasList

Type: Method Returns: Object

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

displayLabel

Synopsis:
Entity displayLabel

Description:
Returns the recipient's name

Type: Method Returns: Object
Also Defined At:
| Object |

displayLabelKey

Synopsis:
Entity displayLabelKey

Description:
Returns the recipient's code

Type: Method Returns: Object
Also Defined At:
| Object |

displayXRefAuditReport

Synopsis:
Entity displayXRefAuditReport

Type: Method Returns: Object

getOrCreate:

Synopsis:
Entity getOrCreate: string

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

Type: Method Returns: Entity
Parameters:
1 - String

getRecordForUser:

Synopsis:
Entity getRecordForUser: userName

Type: Method Returns: Object

helpMessage

Synopsis:
Entity helpMessage

Description:
Returns a message describing the recipient.

Type: Method Returns: String
Also Defined At:
| Object |

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 Returns: List

initialize

Synopsis:
Entity initialize

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

Type: Method Returns: Entity
Also Defined At:
| Currency | Dictionary |

initializeDataBaseLinks

Synopsis:
Entity initializeDataBaseLinks

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

Type: Method Returns: Entity

initializeGlobalInstanceProperties

Synopsis:
Entity initializeGlobalInstanceProperties

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

Type: Method Returns: Entity
Also Defined At:
| Classification | Object |

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

initializeLocalAttributes

Synopsis:
Entity initializeLocalAttributes

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

Type: Method Returns: Entity
Also Defined At:
| Dictionary | Object |

isEntity

Synopsis:
Entity isEntity

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

Type: Constant Returns: TRUE
Also Defined At:
| Object |

loadFromFile:

Synopsis:
Entity loadFromFile: file

Type: Method Returns: Object

loadValuesFor:as:fromFile:

Synopsis:
Entity loadValuesFor: item as: type fromFile: file

Type: Method Returns: Object

locateId:

Synopsis:
Entity locateId: string

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

Type: Method Returns: Entity
Parameters:
1 - String

locateIds:

Synopsis:
Entity locateIds: string

Type: Method Returns: Object

masterListCodes

Synopsis:
Entity masterListCodes

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

Type: Method Returns: Object

name

Synopsis:
Entity name

Description:
Returns descriptive name for recipient.

Type: FixedProperty Returns: String

named

Synopsis:
Entity named

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

Type: Constant Returns: Dictionary
Also Defined At:
| Classification | Currency |

newAs:

Synopsis:
Entity newAs: string

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

Type: Method Returns: Entity
Also Defined At:
| Dictionary | Object |

numericCode

Synopsis:
Entity numericCode

Description:
Returns descriptive numeric code for recipient.

Type: FixedProperty Returns: String

print

Synopsis:
Entity print

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

print:

Synopsis:
Entity print: anInteger

Description:
Prints the recipient code using the supplied format.

Type: Method Returns: Entity
Parameters:
1 - Integer

Also Defined At:
| Boolean | Date | Number | Object | String | Undefined |

profile

Synopsis:
Entity profile

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

Type: Method Returns: Object
Also Defined At:
| Interface | Object |

rebuildAliases

Synopsis:
Entity rebuildAliases

Type: Method Returns: Object

setNameTo:

Synopsis:
Entity setNameTo: string

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

Type: Method Returns: Entity
Parameters:
1 - String

setNumericCodeTo:

Synopsis:
Entity setNumericCodeTo: ordinal

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

Type: Method Returns: Entity
Parameters:
1 - Ordinal

setShortNameTo:

Synopsis:
Entity setShortNameTo: string

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

Type: Method Returns: Entity
Parameters:
1 - String

setSortCodeTo:

Synopsis:
Entity setSortCodeTo: ordinal

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

Type: Method Returns: Entity
Parameters:
1 - Ordinal

setXRefIn:to:

Synopsis:
Entity setXRefIn: dictionary to: string

Type: Method Returns: Object

shortName

Synopsis:
Entity shortName

Description:
Returns descriptive shortName for recipient.

Type: FixedProperty Returns: String

sortCode

Synopsis:
Entity sortCode

Description:
Returns descriptive sortCode for recipient.

Type: FixedProperty 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 Returns: Object
Also Defined At:
| Object |

updateInitializationListWith:

Synopsis:
Entity updateInitializationListWith: block

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

Type: Method Returns: Entity
Parameters:
1 - Block

validateInputString:

Synopsis:
Entity validateInputString: input

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

Type: Method Returns: Object
Also Defined At:
| Object |

whatAmI

Synopsis:
Entity whatAmI

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

Related Topics