Vision Messages: Schema

Profile of Class Schema

Includes Classes: Schema, Schema ClassDescriptor, Schema Descriptor, Schema MessageDescriptor, Schema MessageImplementationDescriptor, ToolKit 


Object
  | 
ToolKit
  | 
  +--- Schema
  |      |
  |      +--- Schema Descriptor
  |      |      |
  |      |      +--- Schema ClassDescriptor
  |      |      |
  |      |      +--- Schema MessageDescriptor
  |      |      |
  |      |      +--- Schema MessageImplementationDescriptor

Message Index

o CD

This constant returns the default instance of the Schema ClassDescriptor class.
o ClassDescriptor
This constant returns the default instance of the Schema ClassDescriptor class.
o Descriptor
This constant returns the default instance of the Schema Descriptor class.
o MD
This constant returns the default instance of the Schema MessageDescriptor class.
o MID
This constant returns the default instance of the Schema MessageImplementationDescriptor class.
o MessageDescriptor
This constant returns the default instance of the Schema MessageDescriptor class.
o MessageDictionary (Schema)
This constant returns the internal dictionary used to cross-reference schema entries.
o MessageDictionary (Schema MessageDescriptor)
Returns an internal dictionary used to cross reference all message names.
o MessageImplementationDescriptor
This constant returns the default instance of the Schema MessageImplementationDescriptor class.
o _htmlDocName
Returns the name of the HTML document that describes this class in detail on insyte's www.
o _imageName
Returns the name of the image file associated with this class.
o accessBlock
This property contains a block that could be sent to an object to execute this message.
o addClass: class
This method creates a class descriptor instance for the supplied class if it does not currently have one and its super class does have a class descriptor.
o addClass: class as: name at: object
This method creates a new class descriptor instance supplying a name to use as the class descriptor's code (if different from the class' 'whatAmI' value) and the object representing the default access path (if different from ^global).
o addClass: class at: object
This method creates a new class descriptor instance, supplying the object representing the default access path (if different from ^global).
o asClassDescriptor
Returns the recipient stripped of extensions.
o asSelf (ToolKit)
Returns the default Schema object, stripped of any extensions.
o asSelf (Schema)
Returns the default Schema object, stripped of any extensions.
o asSelf (Schema Descriptor)
Returns the default Schema Descriptor object, stripped of any extensions.
o asSelf (Schema ClassDescriptor)
Returns the recipient, stripped of extensions.
o asSelf (Schema MessageDescriptor)
Returns the recipient, stripped of extensions.
o asSelf (Schema MessageImplementationDescriptor)
Returns the recipient, stripped of extensions.
o assignDefaultType
Updates the 'type' property in the recipient with a default ClassType based on the underlying class.
o audit
This method is run by the 'Schema processAllMessages' message, summarizing the status of the schema classes after the processing has run.
o autoCreateNamingDictionary
Indicates whether the 'createSubclass' message should automatically create a new naming dictionary for the class.
o briefDescription
Returns the first line of description supplied for a class or message implementation instance
o buildInheritance
This method is invoked by the 'initializeLocalAttributes' message and is used to create the super and subclass maps for the recipient class descriptor.
o childList
This property contains an indexed list of class descriptors that are direct subclasses of the recipient's class.
o class (Schema ClassDescriptor)
This property returns the default instance of the actual class associated with this class descriptor.
o class (Schema MessageImplementationDescriptor)
Returns the default instance of the underlying class associated with the recipient.
o classDescriptor (ToolKit)
Returns the class descriptor for the Schema class.
o classDescriptor (Schema)
Returns the class descriptor for the Schema class.
o classDescriptor (Schema Descriptor)
Returns the class descriptor for the Schema Descriptor class.
o classDescriptor (Schema ClassDescriptor)
This constant returns the class descriptor for the Schema ClassDescriptor class.
o classDescriptor (Schema MessageDescriptor)
This constant returns the class descriptor for the Schema MD class.
o classDescriptor (Schema MessageImplementationDescriptor)
This constant returns the class descriptor for the class Schema MessageImplementationDescriptor.
o cleanupDeletedObject
This method is executed by the 'flagForDeletionWithReason:' message and should not be accessed directly.
o cleanupForClasses: cdList
This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.
o clearDefaultValue
This message is used to clear the default value associated with the recipient.
o clearDefaultValueUsing: mid
This method is used by the 'clearDefaultValue' message defined at MessageImplementationDescriptor and should not be invoked directly.
o clearMessageUpdateFlag
This method is used to clear the flag that indicates that messages have been updated for this class.
o clusterStrings (Schema ClassDescriptor)
This method is used as part of schema maintenance and is not invoked directly.
o clusterStrings (Schema MessageDescriptor)
This method is used as part of the schema maintenance step and is not invoked directly.
o clusterStrings (Schema MessageImplementationDescriptor)
This method is used as part of the schema maintenance step and is not invoked directly.
o createNamingDictionaryAt: dictionary
This method is used to create a naming dictionary for the class if one does not already exist.
o createNewMessagesForClasses: cdList
This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.
o createdInLastPosting
This property is used to flag messages that were created during the most recent execution of the 'Schema processAllMessages' processing.
o defaultAccessPath
This property contains a reference to the class at which this class was defined.
o defaultInstance (ToolKit)
Returns the default Schema instance.
o defaultInstance (Schema)
Returns the default Schema instance.
o defaultInstance (Schema Descriptor)
Returns the default Schema Descriptor instance.
o defaultInstance (Schema ClassDescriptor)
Returns the default Schema ClassDescriptor
o defaultInstance (Schema MessageDescriptor)
Returns the default Schema MessageDescriptor instance.
o defaultInstance (Schema MessageImplementationDescriptor)
Returns the default Schema MessageImplementationDescriptor.
o defaultPropertyList
This property contains a list, indexed by MessageDescriptor, of MessageImplementationDescriptors that provide default values.
o defaultValue
This property is used to store the default value associated with this message.
o deleteMessage: name in: cd
This method runs as part of the 'deleteMessage:' method and is not invoked directly.
o describe
This method is used to display descriptive information about the recipient in a multi-line format.
o description
o displayInfo
Displays the message, type, and class associated with the recipient
o displayStatus
This message displays a description of the current Schema class status.
o flagAsKeyField
Flags the message to indicate it could serve as the 'key' for the class.
o flagAsPartialKeyField
Flags the message to indicate it could serve as one of the 'keys' for the class.
o flagForMessageUpdate
This method is used to set the flag that indicates that messages have been updated for this class.
o formatMessageDescription
Formats the description to adjust for various conventions used by different document browsers.
o formatMessageImplementation
Formats the implementation of the message as a single string that could be used to re-define the message.
o fullSelector
Returns the name of the message with appropriate parameters names filled in for binary and keyword messages.
o functionType (Schema MessageDescriptor)
This property returns an instance of the class FunctionType.
o functionType (Schema MessageImplementationDescriptor)
This property returns an instance of the class FunctionType.
o genericClassDescriptor
o getAllChildren
This message returns a list of class descriptors that refer to sub classes of the recipient.
o getClassesNeedingUpdate
This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.
o getInheritancePath
This message returns a list of class descriptors representing the super class hierarchy of the recipient.
o getInternalMessage
This method returns the internal form of the underlying message and is not used directly.
o getMessage: string in: cd
This method returns the MessageImplementationDescriptor for the supplied message string and classDescriptor combination.
o getMessageFor: string
This method returns the MessageDescriptor for the supplied string.
o getMessageImplementationFor: message
This method is invoked by the "getMessage:" message and is not used directly.
o getMessagesReturningClass
Returns the list of MessageImplementationDescriptors that return an instance of the recipient's class or one of its subclasses.
o getMessagesReturningSuperClass
Returns the list of MessageImplementationDescriptors that return an instance of one of the recipient's super classes.
o getOrCreate: name in: cd
This method returns the MessageImplementationDescriptor for the message string and classDescriptor provided, creating new instances of Schema MessageDescriptor and Schema MessageImplementation as needed.
o getSelector
This method returns the underlying message and is used to initialize the 'fullSelector' property.
o hasDefaultValue
This property contains the value TRUE if the recipient has a default value, NA otherwise.
o htmlDocName
Returns the name of the HTML document that describes this class in detail on insyte's www.
o imageName
Returns the name of the image file associated with this class formatted as an image tag if defined.
o implementationList
This property contains an indexed list of message implementation descriptors defined for the message associated with the recipient.
o implementationSource
This property tracks the actual implementation of a message over time.
o includeInDataModel (Schema ClassDescriptor)
Returns TRUE if the recipient's class is an application class, FALSE otherwise.
o includeInDataModel (Schema MessageImplementationDescriptor)
This method returns TRUE if the functionType property is set to the Data instance.
o inheritancePath
This property returns a list, indexed by class descriptor of the class descriptors in the recipient's super class hierarchy including the recipient.
o inheritsFrom: classDescriptor
This method returns TRUE if the class associated with the recipient object inherits from the class associated with the class descriptor provided, FALSE otherwise.
o initializeClass: class
This method runs as part of the 'addClass:' process and is not invoked directly.
o initializeDefaultInstance
This method is run as part of the 'initializeLocalAttributes' step of new class descriptor creation.
o initializeDefaultPropertyList
This method is run as part of the 'initializeLocalAttributes' step of new class descriptor creation.
o initializeForPosting (Schema)
This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.
o initializeForPosting (Schema MessageImplementationDescriptor)
This method runs as part of the 'Schema processAllMessages' process.
o initializeKeys: keys (Schema ClassDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeKeys: key (Schema MessageDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeKeys: keys (Schema MessageImplementationDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeLocalAttributes (Schema ClassDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeLocalAttributes (Schema MessageDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeLocalAttributes (Schema MessageImplementationDescriptor)
This method is run as part of the 'createInstance:' process.
o initializeNamingDictionary
This method looks at the 'autoCreateNamingDictionary' flag and creates a new naming dictionary if it is set to TRUE.
o internalMethod
This property contains the internal form of the underlying message and is not used directly.
o internalSelector
This property is used to store an internal representation of the selector used to define the message.
o isApplicationClass
Returns TRUE if the recipient's type is Named ClassType Application.
o isBuiltInClass
Returns TRUE if the recipient's type is Named ClassType BuiltIn.
o isClassDescriptor
Returns the value TRUE.
o isDescriptor
Returns the value TRUE when sent to any Schema Descriptor.
o isInInheritancePathOf: classDescriptor
This method returns TRUE if the recipient inherits from the supplied parameter or the supplied parameter inherits from the recipient.
o isIncorporatorClass
Returns TRUE if the recipient's class inherits from IncorporatorPrototype.
o isMessageDescriptor
Returns the value TRUE.
o isMessageImplementationDescriptor
Returns the value TRUE.
o isObjectDescriptor
This method returns TRUE if the recipient is Object's classDescriptor.
o isObjectSpaceClass
Returns TRUE if the recipient's type is Named ClassType ObjectSpace.
o isSchema
Returns the value TRUE when recipient is any Schema object.
o isSubClassOf: classDescriptor
Returns TRUE if the recipient is a sub class of the parameter.
o isSuperClassOf: classDescriptor
Returns TRUE if the recipient is a super class of the parameter.
o isTimeVarying
This method returns TRUE if the 'type' property refers to a TimeSeriesProperty or a TimeVaryingMethod.
o isToolKit
o keyType
Returns the KeyType (Full or Partial) if appropriate, NA otherwise.
o lastPosting
This property contains the time stamp of the last Schema update.
o loadDescriptionsFrom: file
Loads descriptive information from a tab-delimited file containing the following fields: class, message, keyType, returns, container, tvFlag, description, parameter1, .
o message (Schema MessageDescriptor)
This method returns the recipient's message name.
o message (Schema MessageImplementationDescriptor)
This method returns the string associated with the message.
o messageClassDescriptor
This property returns the class descriptor for the class associated with this recipient.
o messageDescriptor
This property returns the message descriptor for the message associated with this recipient.
o messageType
Used to determine the underlying type of a message, this message is not normally used directly.
o messagesHaveBeenUpdated
This property flags classes whose message dictionary has changed since messages were last posted.
o name
Returns descriptive name for recipient.
o namingDictionary
This property returns the naming dictionary for the class.
o number
This property contains the instance number for this class descriptor.
o objectDescriptor
This constant returns the classDescriptor for the class Object.
o parameterList
Returns an indexed list of class descriptors describing the parameters associated with this message if this is a keyword or binary and message.
o parent
This property returns the class descriptor associated with the super class of the recipient's underlying class.
o print
Prints the recipient object's code.
o print: format
Prints the recipient object's code.
o processAllMessages
This method is used to post all new and updated messages in the schema database.
o refreshExistingSelectorsForClasses: cdList
This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.
o refreshValues
This method is executed as part of the 'Schema processAllMessages' process.
o refreshedInLastPosting
This property is used to flag messages that were refreshed during the most recent execution of the 'Schema processAllMessages' processing.
o returnObjectContainer
This property contains the class descriptor for the type of container returned by this message.
o returnObjectType
This property contains the class descriptor for the type of object returned by this message.
o sampleUsage
Describes sample syntax for accessing instances of the recipient's underlying class.
o setAutoCreateNamingDictionaryOff
This method is used to indicate that new subclasses should not automatically create new naming dictionaries.
o setAutoCreateNamingDictionaryOn
This method is used to indicate that new subclasses should automatically create new naming dictionaries.
o setClassTypeTo: typeCode
This method is used to change the value of 'type' from its initial value (e.
o setDefaultValueOf: name at: cd to: default
This method runs as part of the 'defineFixedProperty:withDefault:' method and is not invoked directly.
o setDefaultValueTo: val
This method is used to set the default value for messages that are fixed properties.
o setDescriptionTo: string (ToolKit)
Sets the description for this message descriptor and sets the description for any implementations of this message that currently have no description.
o setDescriptionTo: text (Schema MessageDescriptor)
Sets the description for this message descriptor and sets the description for any implementations of this message that currently have no description.
o setDescriptionTo: text (Schema MessageImplementationDescriptor)
This method is used to update the description property.
o setFunctionTypeTo: type (Schema MessageDescriptor)
This method is used to set or change the value of the 'functionType' property.
o setFunctionTypeTo: type (Schema MessageImplementationDescriptor)
This method is used to set or change the value of the 'functionType' property.
o setGenericClassTo: descriptor
o setHtmlDocNameTo: string
Redefines the name of the html document describing the recipient's underlying class.
o setImplementationTextTo: text forMethod: method
This method is executed as part of the 'Schema processAllMessages' process.
o setImplementationTo: text
This method is executed as part of the 'Schema processAllMessages' process.
o setLevelTo: string
This method is used to set or change the value of the 'usageLevel' property.
o setNamingDictionaryTo: dictionary
This method is used to set the naming dictionary for the recipient to an existing dictionary.
o setParameter: number typeTo: parameterType
Indicates the type of value expected for a parameter of a binary or keyword message.
o setReturnObjectContainerTo: cd
This method sets the value of the returnObjectContainer property and should be one of Object, List, TimeSeries, or IndexedList.
o setReturnObjectTypeTo: cd
This method is used to set the value of the 'returnObjectType' property.
o setSampleUsageTo: text
Updates the property 'sampleUsage'.
o setSelectorTo: string
This method is used to update the 'fullSelector' property.
o setSiteNameTo: name
Defines a constant representing the name of the Vision database.
o setTypeTo: newType
This method is used to set the 'type' property to the message type of the current implementation.
o setupAccessBlocks
This method is used to set the values for 'accessBlock' and 'updateBlock'.
o showChildren
This method recursively displays each subclass of the recipient class.
o showChildrenAtLevel: level
This method is used to implement the recursive display of child classes in the 'showChildren' method.
o showInheritance
This method displays the inheritance hierarchy for the recipient.
o showParents
This method displays the super class hierarchy for the recipient.
o siteDescription
Returns a description of this Vision database.
o siteName
Returns the name of this Vision database
o trackDefaultValueUsing: mid
This method is used to manage the default values for the class and should not be accessed directly.
o type (Schema ClassDescriptor)
This property returns an instance of the class ClassType.
o type (Schema MessageImplementationDescriptor)
This property returns the value if the recipient's message type: Constant, FixedProperty, TimeSeriesProperty, Method, TimeVaryingMethod, or Primitive.
o updateBlock
This property contains a block that could be sent to an object to update the property associated with this message.
o updateDate
This property returns the date this message implementation was last changed.
o updateMethod: name at: cd with: source
This method runs as part of the 'defineMethod:' method when you provide your method definition as a text string.
o usageLevel
This property returns the usage level of the recipient.
o whatAmI (ToolKit)
Returns the name of the recipient's class.
o whatAmI (Schema)
Returns the name of the recipient's class.
o whatAmI (Schema Descriptor)
Returns the string "Schema Descriptor".
o whatAmI (Schema ClassDescriptor)
Returns the string "Schema ClassDescriptor".
o whatAmI (Schema MessageDescriptor)
Returns the string "Schema MessageDescriptor".
o whatAmI (Schema MessageImplementationDescriptor)
Returns the string "Schema MessageImplementationDescriptor" .

Messages

o CD

Synopsis:
Schema CD

Description:

This constant returns the default instance of the Schema ClassDescriptor class.

Type: Constant          Returns: Schema ClassDescriptor

o ClassDescriptor

Synopsis:
Schema ClassDescriptor

Description:

This constant returns the default instance of the Schema ClassDescriptor class.

Type: Constant          Returns: Schema ClassDescriptor

o Descriptor

Synopsis:
Schema Descriptor

Description:

This constant returns the default instance of the Schema Descriptor class.

Type: Constant          Returns: Schema Descriptor

o MD

Synopsis:
Schema MD

Description:

This constant returns the default instance of the Schema MessageDescriptor class.

Type: Constant          Returns: Schema MessageDescriptor

o MID

Synopsis:
Schema MID

Description:

This constant returns the default instance of the Schema MessageImplementationDescriptor class.

Type: Constant          Returns: Schema MessageImplementationDescriptor

o MessageDescriptor

Synopsis:
Schema MessageDescriptor

Description:

This constant returns the default instance of the Schema MessageDescriptor class.

Type: Constant          Returns: Schema MessageDescriptor

o MessageDictionary

Synopsis:
Schema MessageDictionary

Description:

This constant returns the internal dictionary used to cross-reference schema entries.

Type: Constant          Returns: SystemDictionary

o MessageDictionary

Synopsis:
Schema MessageDescriptor MessageDictionary

Description:

Returns an internal dictionary used to cross reference all message names.

Type: Constant          Returns: SystemDictionary

Also Defined At:
| Schema |

o MessageImplementationDescriptor

Synopsis:
Schema MessageImplementationDescriptor

Description:

This constant returns the default instance of the Schema MessageImplementationDescriptor class.

Type: Constant          Returns: Schema MessageImplementationDescriptor

o _htmlDocName

Synopsis:
Schema ClassDescriptor _htmlDocName

Description:

Returns the name of the HTML document that describes this class in detail on insyte's www.insytenet.com web site.

Type: FixedProperty          Returns: String

o _imageName

Synopsis:
Schema ClassDescriptor _imageName

Description:

Returns the name of the image file associated with this class.

Type: FixedProperty          Returns: String

o accessBlock

Synopsis:
Schema MessageDescriptor accessBlock

Description:

This property contains a block that could be sent to an object to execute this message.

Type: FixedProperty          Returns: Block

o addClass:

Synopsis:
Schema addClass: class

Description:

This method creates a class descriptor instance for the supplied class if it does not currently have one and its super class does have a class descriptor.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Object

o addClass:as:at:

Synopsis:
Schema addClass: class as: name at: object

Description:

This method creates a new class descriptor instance supplying a name to use as the class descriptor's code (if different from the class' 'whatAmI' value) and the object representing the default access path (if different from ^global).

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Object
2 - String
3 - Object

o addClass:at:

Synopsis:
Schema addClass: class at: object

Description:

This method creates a new class descriptor instance, supplying the object representing the default access path (if different from ^global).

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Object
2 - Object

o asClassDescriptor

Synopsis:
Schema ClassDescriptor asClassDescriptor

Description:

Returns the recipient stripped of extensions.

Type: Method          Returns: Object

Also Defined At:
| Object |

o asSelf

Synopsis:
ToolKit asSelf

Description:

Returns the default Schema object, stripped of any extensions.

Type: Primitive          Returns: Object

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o asSelf

Synopsis:
Schema asSelf

Description:

Returns the default Schema object, stripped of any extensions.

Type: Primitive          Returns: Schema

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | String | TimeSeries | Undefined | Utility |

o asSelf

Synopsis:
Schema Descriptor asSelf

Description:

Returns the default Schema Descriptor object, stripped of any extensions.

Type: Primitive          Returns: Schema Descriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o asSelf

Synopsis:
Schema ClassDescriptor asSelf

Description:

Returns the recipient, stripped of extensions.

Type: Primitive          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o asSelf

Synopsis:
Schema MessageDescriptor asSelf

Description:

Returns the recipient, stripped of extensions.

Type: Primitive          Returns: Schema MessageDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o asSelf

Synopsis:
Schema MessageImplementationDescriptor asSelf

Description:

Returns the recipient, stripped of extensions.

Type: Primitive          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o assignDefaultType

Synopsis:
Schema ClassDescriptor assignDefaultType

Description:

Updates the 'type' property in the recipient with a default ClassType based on the underlying class. This method runs as a part of new instance initializations.

Type: Method          Returns: Schema ClassDescriptor

o audit

Synopsis:
Schema audit

Description:

This method is run by the 'Schema processAllMessages' message, summarizing the status of the schema classes after the processing has run.

Type: Method          Returns: NoValue

o autoCreateNamingDictionary

Synopsis:
Schema ClassDescriptor autoCreateNamingDictionary

Description:

Indicates whether the 'createSubclass' message should automatically create a new naming dictionary for the class. This property is set using the 'setAutoCreateNamingDictionaryOn' and 'setAutoCreateNamingDictionaryOff' messages.

Type: FixedProperty          Returns: Boolean

o briefDescription

Synopsis:
Schema briefDescription

Description:

Returns the first line of description supplied for a class or message implementation instance

Type: Method          Returns: String

o buildInheritance

Synopsis:
Schema ClassDescriptor buildInheritance

Description:

This method is invoked by the 'initializeLocalAttributes' message and is used to create the super and subclass maps for the recipient class descriptor. It should not be used directly.

Type: Method          Returns: NoValue

o childList

Synopsis:
Schema ClassDescriptor childList

Description:

This property contains an indexed list of class descriptors that are direct subclasses of the recipient's class.

Type: FixedProperty          Returns: Schema ClassDescriptor

Parameters:

1 - Schema ClassDescriptor

o class

Synopsis:
Schema ClassDescriptor class

Description:

This property returns the default instance of the actual class associated with this class descriptor.

Type: FixedProperty          Returns: Object

o class

Synopsis:
Schema MessageImplementationDescriptor class

Description:

Returns the default instance of the underlying class associated with the recipient.

Type: Method          Returns: Object

o classDescriptor

Synopsis:
ToolKit classDescriptor

Description:

Returns the class descriptor for the Schema class.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o classDescriptor

Synopsis:
Schema classDescriptor

Description:

Returns the class descriptor for the Schema class.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | String | TimeSeries | Undefined | Utility |

o classDescriptor

Synopsis:
Schema Descriptor classDescriptor

Description:

Returns the class descriptor for the Schema Descriptor class.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o classDescriptor

Synopsis:
Schema ClassDescriptor classDescriptor

Description:

This constant returns the class descriptor for the Schema ClassDescriptor class.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o classDescriptor

Synopsis:
Schema MessageDescriptor classDescriptor

Description:

This constant returns the class descriptor for the Schema MD class.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o classDescriptor

Synopsis:
Schema MessageImplementationDescriptor classDescriptor

Description:

This constant returns the class descriptor for the class Schema MessageImplementationDescriptor.

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o cleanupDeletedObject

Synopsis:
Schema MessageImplementationDescriptor cleanupDeletedObject

Description:

This method is executed by the 'flagForDeletionWithReason:' message and should not be accessed directly.

Type: Method          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Object |

o cleanupForClasses:

Synopsis:
Schema cleanupForClasses: cdList

Description:

This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.

Type: Method          Returns: NoValue

Parameters:

1 - List

o clearDefaultValue

Synopsis:
Schema MessageImplementationDescriptor clearDefaultValue

Description:

This message is used to clear the default value associated with the recipient. Default values are used to initialize new instances of the class during instance creation.

Type: Method          Returns: Schema MessageImplementationDescriptor

o clearDefaultValueUsing:

Synopsis:
Schema ClassDescriptor clearDefaultValueUsing: mid

Description:

This method is used by the 'clearDefaultValue' message defined at MessageImplementationDescriptor and should not be invoked directly.

Type: Method          Returns: NoValue

Parameters:

1 - Object

o clearMessageUpdateFlag

Synopsis:
Schema ClassDescriptor clearMessageUpdateFlag

Description:

This method is used to clear the flag that indicates that messages have been updated for this class. It is not usually invoked directly.

Type: Method          Returns: NoValue

o clusterStrings

Synopsis:
Schema ClassDescriptor clusterStrings

Description:

This method is used as part of schema maintenance and is not invoked directly.

Type: Method          Returns: NoValue

Also Defined At:
| Entity |

o clusterStrings

Synopsis:
Schema MessageDescriptor clusterStrings

Description:

This method is used as part of the schema maintenance step and is not invoked directly.

Type: Method          Returns: NoValue

Also Defined At:
| Entity |

o clusterStrings

Synopsis:
Schema MessageImplementationDescriptor clusterStrings

Description:

This method is used as part of the schema maintenance step and is not invoked directly.

Type: Method          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Entity |

o createNamingDictionaryAt:

Synopsis:
Schema ClassDescriptor createNamingDictionaryAt: dictionary

Description:

This method is used to create a naming dictionary for the class if one
does not already exist. The parameter should itself be a dictionary
that is used to name references to other dictionaries (e.g., Named).
This method creates a new instance of this dictionary, assigns it to
the 'namingDictionary' property at the class descriptor, and defines
the class descriptor's code at the supplied dictionary to return this
new dictionary. Current instances in the class are then added to
the dictionary. For example, to create a dictionary for MyClass at Named
use:

MyClass classDescriptor createNamingDictionaryAt: Named ;

If MyClass had an instance with code "my1", the expression:

Named MyClass my1

would access this instance. All new instances would automatically get
cross-referenced in this naming dictionary.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Dictionary

o createNewMessagesForClasses:

Synopsis:
Schema createNewMessagesForClasses: cdList

Description:

This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.

Type: Method          Returns: NoValue

Parameters:

1 - List

o createdInLastPosting

Synopsis:
Schema MessageImplementationDescriptor createdInLastPosting

Description:

This property is used to flag messages that were created during the most recent execution of the 'Schema processAllMessages' processing.

Type: FixedProperty          Returns: TRUE

o defaultAccessPath

Synopsis:
Schema ClassDescriptor defaultAccessPath

Description:

This property contains a reference to the class at which this class
was defined. For example, the expression:

Schema ClassDescriptor classDescriptor defaultAccessPath

returns the class Schema.

Type: FixedProperty          Returns: Object

o defaultInstance

Synopsis:
ToolKit defaultInstance

Description:

Returns the default Schema instance.

Type: Constant          Returns: ToolKit

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o defaultInstance

Synopsis:
Schema defaultInstance

Description:

Returns the default Schema instance.

Type: Constant          Returns: Schema

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | String | TimeSeries | Undefined | Utility |

o defaultInstance

Synopsis:
Schema Descriptor defaultInstance

Description:

Returns the default Schema Descriptor instance.

Type: Constant          Returns: Schema Descriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o defaultInstance

Synopsis:
Schema ClassDescriptor defaultInstance

Description:

Returns the default Schema ClassDescriptor

Type: Constant          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o defaultInstance

Synopsis:
Schema MessageDescriptor defaultInstance

Description:

Returns the default Schema MessageDescriptor instance.

Type: Constant          Returns: Schema MessageDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o defaultInstance

Synopsis:
Schema MessageImplementationDescriptor defaultInstance

Description:

Returns the default Schema MessageImplementationDescriptor.

Type: Constant          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o defaultPropertyList

Synopsis:
Schema ClassDescriptor defaultPropertyList

Description:

This property contains a list, indexed by MessageDescriptor, of MessageImplementationDescriptors that provide default values. This list is used to initialize new instances of the class. The list is maintained by the messages defined at MessageImplementationDescriptor and should not be changed directly.

Type: FixedProperty          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Schema MessageDescriptor

o defaultValue

Synopsis:
Schema MessageImplementationDescriptor defaultValue

Description:

This property is used to store the default value associated with this message. The value is set and cleared using the 'setDefaultValueTo:' and 'clearDefaultValue' messages.

Type: FixedProperty          Returns: Object

o deleteMessage:in:

Synopsis:
Schema deleteMessage: name in: cd

Description:

This method runs as part of the 'deleteMessage:' method and is not invoked directly.

Type: Method          Returns: Object

Parameters:

1 - String
2 - Schema ClassDescriptor

o describe

Synopsis:
Schema MessageImplementationDescriptor describe

Description:

This method is used to display descriptive information about the recipient in a multi-line format.

Type: Method          Returns: NoValue

o description

Synopsis:
ToolKit description

Type: FixedProperty          Returns: Object

o displayInfo

Synopsis:
Schema MessageImplementationDescriptor displayInfo

Description:

Displays the message, type, and class associated with the recipient

Type: Method          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Entity | Object |

o displayStatus

Synopsis:
Schema displayStatus

Description:

This message displays a description of the current Schema class status.

Type: Method          Returns: NoValue

o flagAsKeyField

Synopsis:
Schema MessageImplementationDescriptor flagAsKeyField

Description:

Flags the message to indicate it could serve as the 'key' for the class. Although, Vision does not require or use directly, this is sometimes useful for classes that are presented as part of a data model.

Type: Method          Returns: Schema MessageImplementationDescriptor

o flagAsPartialKeyField

Synopsis:
Schema MessageImplementationDescriptor flagAsPartialKeyField

Description:

Flags the message to indicate it could serve as one of the 'keys' for the class. Although, Vision does not require or use directly, this is sometimes useful for classes that are presented as part of a data model.

Type: Method          Returns: Schema MessageImplementationDescriptor

o flagForMessageUpdate

Synopsis:
Schema ClassDescriptor flagForMessageUpdate

Description:

This method is used to set the flag that indicates that messages have been updated for this class. It is not usually invoked directly.

Type: Method          Returns: NoValue

o formatMessageDescription

Synopsis:
Schema MessageImplementationDescriptor formatMessageDescription

Description:

Formats the description to adjust for various conventions used by different document browsers.

Type: Method          Returns: String

o formatMessageImplementation

Synopsis:
Schema MessageImplementationDescriptor formatMessageImplementation

Description:

Formats the implementation of the message as a single string that could be used to re-define the message.

Type: Method          Returns: String

o fullSelector

Synopsis:
Schema MessageImplementationDescriptor fullSelector

Description:

Returns the name of the message with appropriate parameters names filled in for binary and keyword messages.

Type: FixedProperty          Returns: String

o functionType

Synopsis:
Schema MessageDescriptor functionType

Description:

This property returns an instance of the class FunctionType. You can create and set function types with the 'setFunctionTypeTo:' message.

Type: FixedProperty          Returns: FunctionType

o functionType

Synopsis:
Schema MessageImplementationDescriptor functionType

Description:

This property returns an instance of the class FunctionType. You can create and set function types with the 'setFunctionTypeTo:' message.

Type: FixedProperty          Returns: FunctionType

o genericClassDescriptor

Synopsis:
Schema ClassDescriptor genericClassDescriptor

Description:

Type: FixedProperty          Returns: Object

o getAllChildren

Synopsis:
Schema ClassDescriptor getAllChildren

Description:

This message returns a list of class descriptors that refer to sub classes of the recipient.

Type: Method          Returns: Schema ClassDescriptor

o getClassesNeedingUpdate

Synopsis:
Schema getClassesNeedingUpdate

Description:

This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.

Type: Method          Returns: Schema ClassDescriptor

o getInheritancePath

Synopsis:
Schema ClassDescriptor getInheritancePath

Description:

This message returns a list of class descriptors representing the super class hierarchy of the recipient. The list is sorted with the class descriptor for Object first and the class descriptor for the recipient class last.

Type: Method          Returns: Schema ClassDescriptor

o getInternalMessage

Synopsis:
Schema MessageImplementationDescriptor getInternalMessage

Description:

This method returns the internal form of the underlying message and is not used directly.

Type: Method          Returns: String

o getMessage:in:

Synopsis:
Schema MessageDescriptor getMessage: string in: cd

Description:

This method returns the MessageImplementationDescriptor for the supplied message string and classDescriptor combination.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String
2 - Schema ClassDescriptor

o getMessageFor:

Synopsis:
Schema MessageDescriptor getMessageFor: string

Description:

This method returns the MessageDescriptor for the supplied string.

Type: Method          Returns: Schema MessageDescriptor

Parameters:

1 - String

o getMessageImplementationFor:

Synopsis:
Schema ClassDescriptor getMessageImplementationFor: message

Description:

This method is invoked by the "getMessage:" message and is not used directly.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o getMessagesReturningClass

Synopsis:
Schema ClassDescriptor getMessagesReturningClass

Description:

Returns the list of MessageImplementationDescriptors that return an instance of the recipient's class or one of its subclasses.

Type: Method          Returns: Schema MessageImplementationDescriptor

o getMessagesReturningSuperClass

Synopsis:
Schema ClassDescriptor getMessagesReturningSuperClass

Description:

Returns the list of MessageImplementationDescriptors that return an instance of one of the recipient's super classes. This is useful if you want to find the messages that potentially return an instance of this class. For example, a message that returns an arbitrary Entity, could potentially return a Currency, Security, or Country object.

Type: Method          Returns: Schema MessageImplementationDescriptor

o getOrCreate:in:

Synopsis:
Schema MessageDescriptor getOrCreate: name in: cd

Description:

This method returns the MessageImplementationDescriptor for the message string and classDescriptor provided, creating new instances of Schema MessageDescriptor and Schema MessageImplementation as needed.

Type: Method          Returns: Schema MessageDescriptor

Parameters:

1 - String
2 - Schema ClassDescriptor

o getSelector

Synopsis:
Schema MessageImplementationDescriptor getSelector

Description:

This method returns the underlying message and is used to initialize the 'fullSelector' property.

Type: Method          Returns: String

o hasDefaultValue

Synopsis:
Schema MessageImplementationDescriptor hasDefaultValue

Description:

This property contains the value TRUE if the recipient has a default value, NA otherwise. Its value is controlled by the 'setDefaultValueTo:' and 'clearDefaultValue' messages.

Type: FixedProperty          Returns: Boolean

o htmlDocName

Synopsis:
Schema ClassDescriptor htmlDocName

Description:

Returns the name of the HTML document that describes this class in detail on insyte's www.insytenet.com web site; if not document is specifically defined, the document name associated with the first super class in the recipient's hierarchy that has a document is returned.

Type: Method          Returns: String

o imageName

Synopsis:
Schema ClassDescriptor imageName

Description:

Returns the name of the image file associated with this class formatted as an image tag if defined. The class name is returned otherwise.

Type: Method          Returns: String

o implementationList

Synopsis:
Schema MessageDescriptor implementationList

Description:

This property contains an indexed list of message implementation descriptors defined for the message associated with the recipient. The list is indexed by classDescriptor.

Type: FixedProperty          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Schema ClassDescriptor

o implementationSource

Synopsis:
Schema MessageImplementationDescriptor implementationSource

Description:

This property tracks the actual implementation of a message over time. Each time the message definition changes, this time series is updated to reflect the new value. This property can be accessed directly to display current and prior values. Updates to this property are managed by the 'Schema processAllMessages' process.

Type: TimeSeriesProperty          Returns: String

o includeInDataModel

Synopsis:
Schema ClassDescriptor includeInDataModel

Description:

Returns TRUE if the recipient's class is an application class, FALSE otherwise.

Type: Method          Returns: Boolean

o includeInDataModel

Synopsis:
Schema MessageImplementationDescriptor includeInDataModel

Description:

This method returns TRUE if the functionType property is set to the Data instance.

Type: Method          Returns: Boolean

o inheritancePath

Synopsis:
Schema ClassDescriptor inheritancePath

Description:

This property returns a list, indexed by class descriptor of the class descriptors in the recipient's super class hierarchy including the recipient.

Type: FixedProperty          Returns: Schema ClassDescriptor

Parameters:

1 - Schema ClassDescriptor

o inheritsFrom:

Synopsis:
Schema ClassDescriptor inheritsFrom: classDescriptor

Description:

This method returns TRUE if the class associated with the recipient object inherits from the class associated with the class descriptor provided, FALSE otherwise. This is similar to the version at Object except the class descriptors of the two classes are used for the inquiry.

Type: Method          Returns: Boolean

Parameters:

1 - Schema ClassDescriptor

Also Defined At:
| Object |

o initializeClass:

Synopsis:
Schema initializeClass: class

Description:

This method runs as part of the 'addClass:' process and is not invoked directly.

Type: Method          Returns: NoValue

Parameters:

1 - Object

o initializeDefaultInstance

Synopsis:
Schema ClassDescriptor initializeDefaultInstance

Description:

This method is run as part of the 'initializeLocalAttributes' step of new class descriptor creation. If the class has a naming dictionary, it adds a reference to the newly created Class as "Default". If the new class shares the parent's naming dictionary, the name added to the dictionary concatenates the class name to the string "Default".

Type: Method          Returns: Schema ClassDescriptor

o initializeDefaultPropertyList

Synopsis:
Schema ClassDescriptor initializeDefaultPropertyList

Description:

This method is run as part of the 'initializeLocalAttributes' step of new class descriptor creation. It copies the defaultPropertyList from its parent class descriptor.

Type: Method          Returns: Schema ClassDescriptor

o initializeForPosting

Synopsis:
Schema initializeForPosting

Description:

This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.

Type: Method          Returns: NoValue

o initializeForPosting

Synopsis:
Schema MessageImplementationDescriptor initializeForPosting

Description:

This method runs as part of the 'Schema processAllMessages' process.

Type: Method          Returns: NoValue

Also Defined At:
| Schema |

o initializeKeys:

Synopsis:
Schema ClassDescriptor initializeKeys: keys

Description:

This method is run as part of the 'createInstance:' process. Three keys are supplied: the default instance of the class, the class name, and the default access path. These values are used to set the values of the 'class', 'code', and 'defaultAccessPath' properties in the new class descriptor.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - List

Also Defined At:
| Object |

o initializeKeys:

Synopsis:
Schema MessageDescriptor initializeKeys: key

Description:

This method is run as part of the 'createInstance:' process. A single string representing the message is supplied as the key.

Type: Method          Returns: Schema MessageDescriptor

Parameters:

1 - List

Also Defined At:
| Object |

o initializeKeys:

Synopsis:
Schema MessageImplementationDescriptor initializeKeys: keys

Description:

This method is run as part of the 'createInstance:' process. The first key provided represents the message descriptor and the second key is the class descriptor.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - List

Also Defined At:
| Object |

o initializeLocalAttributes

Synopsis:
Schema ClassDescriptor initializeLocalAttributes

Description:

This method is run as part of the 'createInstance:' process. It sets the values for a number of properties, builds the inheritance map, initializes the default propertyList, creates a naming dictionary if appropriate, and initializes the default instance.

Type: Method          Returns: Schema ClassDescriptor

Also Defined At:
| Dictionary | Entity | Object |

o initializeLocalAttributes

Synopsis:
Schema MessageDescriptor initializeLocalAttributes

Description:

This method is run as part of the 'createInstance:' process.

Type: Method          Returns: Schema MessageDescriptor

Also Defined At:
| Dictionary | Entity | Object |

o initializeLocalAttributes

Synopsis:
Schema MessageImplementationDescriptor initializeLocalAttributes

Description:

This method is run as part of the 'createInstance:' process.

Type: Method          Returns: Schema MessageImplementationDescriptor

Also Defined At:
| Dictionary | Entity | Object |

o initializeNamingDictionary

Synopsis:
Schema ClassDescriptor initializeNamingDictionary

Description:

This method looks at the 'autoCreateNamingDictionary' flag and creates a new naming dictionary if it is set to TRUE. It creates the dictionary in the same place as its parent's naming dictionary if one exists, otherwise it creates it at ^global Named.

Type: Method          Returns: Schema ClassDescriptor

o internalMethod

Synopsis:
Schema MessageImplementationDescriptor internalMethod

Description:

This property contains the internal form of the underlying message and is not used directly.

Type: FixedProperty          Returns: String

o internalSelector

Synopsis:
Schema MessageDescriptor internalSelector

Description:

This property is used to store an internal representation of the selector used to define the message.

Type: FixedProperty          Returns: String

o isApplicationClass

Synopsis:
Schema ClassDescriptor isApplicationClass

Description:

Returns TRUE if the recipient's type is Named ClassType Application.

Type: Method          Returns: Boolean

o isBuiltInClass

Synopsis:
Schema ClassDescriptor isBuiltInClass

Description:

Returns TRUE if the recipient's type is Named ClassType BuiltIn.

Type: Method          Returns: Boolean

o isClassDescriptor

Synopsis:
Schema ClassDescriptor isClassDescriptor

Description:

Returns the value TRUE.

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o isDescriptor

Synopsis:
Schema Descriptor isDescriptor

Description:

Returns the value TRUE when sent to any Schema Descriptor.

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o isInInheritancePathOf:

Synopsis:
Schema ClassDescriptor isInInheritancePathOf: classDescriptor

Description:

This method returns TRUE if the recipient inherits from the supplied parameter or the supplied parameter inherits from the recipient.

Type: Method          Returns: Boolean

Parameters:

1 - Schema ClassDescriptor

o isIncorporatorClass

Synopsis:
Schema ClassDescriptor isIncorporatorClass

Description:

Returns TRUE if the recipient's class inherits from IncorporatorPrototype.

Type: Method          Returns: Boolean

o isMessageDescriptor

Synopsis:
Schema MessageDescriptor isMessageDescriptor

Description:

Returns the value TRUE.

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o isMessageImplementationDescriptor

Synopsis:
Schema MessageImplementationDescriptor isMessageImplementationDescriptor

Description:

Returns the value TRUE.

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o isObjectDescriptor

Synopsis:
Schema ClassDescriptor isObjectDescriptor

Description:

This method returns TRUE if the recipient is Object's classDescriptor.

Type: Method          Returns: Boolean

o isObjectSpaceClass

Synopsis:
Schema ClassDescriptor isObjectSpaceClass

Description:

Returns TRUE if the recipient's type is Named ClassType ObjectSpace.

Type: Method          Returns: Boolean

o isSchema

Synopsis:
Schema isSchema

Description:

Returns the value TRUE when recipient is any Schema object.

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o isSubClassOf:

Synopsis:
Schema ClassDescriptor isSubClassOf: classDescriptor

Description:

Returns TRUE if the recipient is a sub class of the parameter.

Type: Method          Returns: Boolean

Parameters:

1 - Schema ClassDescriptor

o isSuperClassOf:

Synopsis:
Schema ClassDescriptor isSuperClassOf: classDescriptor

Description:

Returns TRUE if the recipient is a super class of the parameter.

Type: Method          Returns: Boolean

Parameters:

1 - Schema ClassDescriptor

Also Defined At:
| Object |

o isTimeVarying

Synopsis:
Schema MessageImplementationDescriptor isTimeVarying

Description:

This method returns TRUE if the 'type' property refers to a TimeSeriesProperty or a TimeVaryingMethod. Note that to a flag a method as time varying, you need to explicitly set its type. Otherwise, the type is determined automatically by the method that creates and manages these descriptors.

Type: Method          Returns: Boolean

o isToolKit

Synopsis:
ToolKit isToolKit

Type: Constant          Returns: TRUE

Also Defined At:
| Object |

o keyType

Synopsis:
Schema MessageImplementationDescriptor keyType

Description:

Returns the KeyType (Full or Partial) if appropriate, NA otherwise.

Type: FixedProperty          Returns: KeyType

o lastPosting

Synopsis:
Schema lastPosting

Description:

This property contains the time stamp of the last Schema update.

Type: FixedProperty          Returns: Utility UnixSeconds

o loadDescriptionsFrom:

Synopsis:
Schema MessageImplementationDescriptor loadDescriptionsFrom: file

Description:

Loads descriptive information from a tab-delimited file containing the following fields: class, message, keyType, returns, container, tvFlag, description, parameter1, ..., parameterN. The information is updated for the MessageImplementationDescriptor associated with the supplied class/message. The 'keyType' can be Full, Partial, or blank. The 'returns' field contains the class of the object returned by the message. The 'container' field contains Object, List, IndexedList, or TimeSeries, and indicates the form in which the result is returned. If the field is blank, the default is that values are returned as a scalar Object. If a collection of objects is returned, you should set the return field to one of the collection classes. The 'tvFlag' field can be used to indicate that a method is time varying. If this field is blank or the message type is not a method, this flag is derived from the database. The 'description' field sets the description for the message. The parameter fields can be used to indicate the types of inputs for binary and keyword messages (one field per keyword) and can also be used to indicate the index type for objects that return an IndexedList container.

Type: Method          Returns: NoValue

Parameters:

1 - String

o message

Synopsis:
Schema MessageDescriptor message

Description:

This method returns the recipient's message name.

Type: Method          Returns: String

o message

Synopsis:
Schema MessageImplementationDescriptor message

Description:

This method returns the string associated with the message. The actual message is stored in the 'code' property.

Type: Method          Returns: String

o messageClassDescriptor

Synopsis:
Schema MessageImplementationDescriptor messageClassDescriptor

Description:

This property returns the class descriptor for the class associated with this recipient.

Type: FixedProperty          Returns: Schema ClassDescriptor

o messageDescriptor

Synopsis:
Schema MessageImplementationDescriptor messageDescriptor

Description:

This property returns the message descriptor for the message associated with this recipient.

Type: FixedProperty          Returns: Schema MessageDescriptor

o messageType

Synopsis:
Schema ClassDescriptor messageType

Description:

Used to determine the underlying type of a message, this message is not normally used directly.

Type: FixedProperty          Returns: MessageType

o messagesHaveBeenUpdated

Synopsis:
Schema ClassDescriptor messagesHaveBeenUpdated

Description:

This property flags classes whose message dictionary has changed since messages were last posted.

Type: FixedProperty          Returns: Boolean

o name

Synopsis:
Schema ClassDescriptor name

Description:

Returns descriptive name for recipient. This is normally the 'whatAmI' for the underlying class.

Type: FixedProperty          Returns: String

Also Defined At:
| Entity |

o namingDictionary

Synopsis:
Schema ClassDescriptor namingDictionary

Description:

This property returns the naming dictionary for the class.

Type: FixedProperty          Returns: Dictionary

o number

Synopsis:
Schema ClassDescriptor number

Description:

This property contains the instance number for this class descriptor.

Type: FixedProperty          Returns: Integer

o objectDescriptor

Synopsis:
Schema ClassDescriptor objectDescriptor

Description:

This constant returns the classDescriptor for the class Object.

Type: Constant          Returns: Schema ClassDescriptor

o parameterList

Synopsis:
Schema MessageImplementationDescriptor parameterList

Description:

Returns an indexed list of class descriptors describing the parameters associated with this message if this is a keyword or binary and message. The first parameter is used to store the index type if this message returns its value as an IndexedList.

Type: FixedProperty          Returns: Schema ClassDescriptor

Parameters:

1 - Integer

o parent

Synopsis:
Schema ClassDescriptor parent

Description:

This property returns the class descriptor associated with the super class of the recipient's underlying class.

Type: FixedProperty          Returns: Schema ClassDescriptor

Also Defined At:
| Classification |

o print

Synopsis:
Schema ClassDescriptor print

Description:

Prints the recipient object's code.

Type: Method          Returns: Schema ClassDescriptor

Also Defined At:
| Block | Date | DateOffset | DateRange | Entity | IndexedList | List | Object | String | TimeSeries | Undefined |

o print:

Synopsis:
Schema ClassDescriptor print: format

Description:

Prints the recipient object's code.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Integer

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

o processAllMessages

Synopsis:
Schema processAllMessages

Description:

This method is used to post all new and updated messages in the schema database. It is periodically run as part of standard update procedures and can be executed temporarily during a session in which you have defined new messages.

Type: Method          Returns: NoValue

o refreshExistingSelectorsForClasses:

Synopsis:
Schema refreshExistingSelectorsForClasses: cdList

Description:

This method runs as part of the 'Schema processAllMessages' process and is not invoked directly.

Type: Method          Returns: NoValue

Parameters:

1 - List

o refreshValues

Synopsis:
Schema MessageImplementationDescriptor refreshValues

Description:

This method is executed as part of the 'Schema processAllMessages' process.

Type: Method          Returns: NoValue

o refreshedInLastPosting

Synopsis:
Schema MessageImplementationDescriptor refreshedInLastPosting

Description:

This property is used to flag messages that were refreshed during the most recent execution of the 'Schema processAllMessages' processing.

Type: FixedProperty          Returns: Boolean

o returnObjectContainer

Synopsis:
Schema MessageImplementationDescriptor returnObjectContainer

Description:

This property contains the class descriptor for the type of container returned by this message. Objects can be returned as a single scalar value, in which case the return object container is Object. Some messages return collections of values, in which case the return object container will be List, IndexedList, or TimeSeries. A message that returns a TimeSeries should not be confused with a time series property or a method that varies over time. Time varying messages will produce different results if they are evaluated as of different dates but do not actually return a TimeSeries object. A message that returns a TimeSeries container is actually returning a TimeSeries object which responds to all the TimeSeries messages.

Type: FixedProperty          Returns: Schema ClassDescriptor

o returnObjectType

Synopsis:
Schema MessageImplementationDescriptor returnObjectType

Description:

This property contains the class descriptor for the type of object returned by this message. By default, the class descriptor for Object is returned. You can change this value using the 'setReturnObjectTypeTo:' message. If the message returns a collection of objects, this property is set to the type of object included in the collection. The property 'returnObjectContainer' would indicate that the result is returned as a collection.

Type: FixedProperty          Returns: Schema ClassDescriptor

o sampleUsage

Synopsis:
Schema ClassDescriptor sampleUsage

Description:

Describes sample syntax for accessing instances of the recipient's underlying class.

Type: FixedProperty          Returns: String

o setAutoCreateNamingDictionaryOff

Synopsis:
Schema ClassDescriptor setAutoCreateNamingDictionaryOff

Description:

This method is used to indicate that new subclasses should not automatically create new naming dictionaries.

Type: Method          Returns: Schema ClassDescriptor

o setAutoCreateNamingDictionaryOn

Synopsis:
Schema ClassDescriptor setAutoCreateNamingDictionaryOn

Description:

This method is used to indicate that new subclasses should automatically create new naming dictionaries.

Type: Method          Returns: Schema ClassDescriptor

o setClassTypeTo:

Synopsis:
Schema ClassDescriptor setClassTypeTo: typeCode

Description:

This method is used to change the value of 'type' from its initial value (e.g., Named ClassType Application) to a different type. Available types are: BuiltIn, Application, DataFeed, ToolKit, Dictionary, ObjectSpace, Other, and Unused. The initial value of type is set during instance creation using the method 'assignDefaultType'.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - String

o setDefaultValueOf:at:to:

Synopsis:
Schema setDefaultValueOf: name at: cd to: default

Description:

This method runs as part of the 'defineFixedProperty:withDefault:' method and is not invoked directly.

Type: Method          Returns: Object

Parameters:

1 - String
2 - Schema ClassDescriptor
3 - Object

o setDefaultValueTo:

Synopsis:
Schema MessageImplementationDescriptor setDefaultValueTo: val

Description:

This method is used to set the default value for messages that are fixed properties. This default value will be used to initialize any new instances created for the underlying class. This message also initializes the returnObjectType property to be the class descriptor of the default value.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Object

o setDescriptionTo:

Synopsis:
ToolKit setDescriptionTo: string

Description:

Sets the description for this message descriptor and sets the description for any implementations of this message that currently have no description.

Type: Method          Returns: Object

o setDescriptionTo:

Synopsis:
Schema MessageDescriptor setDescriptionTo: text

Description:

Sets the description for this message descriptor and sets the description for any implementations of this message that currently have no description.

Type: Method          Returns: Schema MessageDescriptor

Parameters:

1 - String

o setDescriptionTo:

Synopsis:
Schema MessageImplementationDescriptor setDescriptionTo: text

Description:

This method is used to update the description property. If the recipient's message description is NA, it will be set to the same value.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o setFunctionTypeTo:

Synopsis:
Schema MessageDescriptor setFunctionTypeTo: type

Description:

This method is used to set or change the value of the 'functionType' property. The parameter can be an instance of the class FunctionType or a string. If a string is supplied, and a function type instance by that name does not exist, a new instance of FunctionType is created.

Type: Method          Returns: Schema MessageDescriptor

Parameters:

1 - String

o setFunctionTypeTo:

Synopsis:
Schema MessageImplementationDescriptor setFunctionTypeTo: type

Description:

This method is used to set or change the value of the 'functionType' property. The parameter can be an instance of the class FunctionType or a string. If a string is supplied, and a function type instance by that name does not exist, a new instance of FunctionType is created. If the message descriptor associated with this recipient does not have a function type, it is set to the value provided here.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o setGenericClassTo:

Synopsis:
Schema ClassDescriptor setGenericClassTo: descriptor

Description:

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Schema ClassDescriptor

o setHtmlDocNameTo:

Synopsis:
Schema ClassDescriptor setHtmlDocNameTo: string

Description:

Redefines the name of the html document describing the recipient's underlying class.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - String

o setImplementationTextTo:forMethod:

Synopsis:
Schema MessageImplementationDescriptor setImplementationTextTo: text forMethod: method

Description:

This method is executed as part of the 'Schema processAllMessages' process.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String
2 - Method

o setImplementationTo:

Synopsis:
Schema MessageImplementationDescriptor setImplementationTo: text

Description:

This method is executed as part of the 'Schema processAllMessages' process.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o setLevelTo:

Synopsis:
Schema MessageImplementationDescriptor setLevelTo: string

Description:

This method is used to set or change the value of the 'usageLevel' property. The parameter can be an instance of the class UsageLevel or a string.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o setNamingDictionaryTo:

Synopsis:
Schema ClassDescriptor setNamingDictionaryTo: dictionary

Description:

This method is used to set the naming dictionary for the recipient to an existing dictionary.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - Dictionary

o setParameter:typeTo:

Synopsis:
Schema MessageImplementationDescriptor setParameter: number typeTo: parameterType

Description:

Indicates the type of value expected for a parameter of a binary or keyword message. The first input corresponds to the parameter number; the second input corresponds to the type which will be converted and stored as a class descriptor. Parameter 1 can also be used to store the type of index for messages that return IndexedList containers.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Integer
2 - Object

o setReturnObjectContainerTo:

Synopsis:
Schema MessageImplementationDescriptor setReturnObjectContainerTo: cd

Description:

This method sets the value of the returnObjectContainer property and should be one of Object, List, TimeSeries, or IndexedList.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Object

o setReturnObjectTypeTo:

Synopsis:
Schema MessageImplementationDescriptor setReturnObjectTypeTo: cd

Description:

This method is used to set the value of the 'returnObjectType' property.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Object

o setSampleUsageTo:

Synopsis:
Schema ClassDescriptor setSampleUsageTo: text

Description:

Updates the property 'sampleUsage'.

Type: Method          Returns: Schema ClassDescriptor

Parameters:

1 - String

o setSelectorTo:

Synopsis:
Schema MessageImplementationDescriptor setSelectorTo: string

Description:

This method is used to update the 'fullSelector' property.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - String

o setSiteNameTo:

Synopsis:
Schema setSiteNameTo: name

Description:

Defines a constant representing the name of the Vision database.

Type: Method          Returns: Schema

Parameters:

1 - String

o setTypeTo:

Synopsis:
Schema MessageImplementationDescriptor setTypeTo: newType

Description:

This method is used to set the 'type' property to the message type of the current implementation. The message type is an instance of the class MessageType. This method is executed as part of the 'Schema processAllMessages' process and should not be run directly.

Type: Method          Returns: Schema MessageImplementationDescriptor

Parameters:

1 - Object

o setupAccessBlocks

Synopsis:
Schema MessageDescriptor setupAccessBlocks

Description:

This method is used to set the values for 'accessBlock' and 'updateBlock'. It should not be accessed directly.

Type: Method          Returns: Schema MessageDescriptor

o showChildren

Synopsis:
Schema ClassDescriptor showChildren

Description:

This method recursively displays each subclass of the recipient class.

Type: Method          Returns: NoValue

o showChildrenAtLevel:

Synopsis:
Schema ClassDescriptor showChildrenAtLevel: level

Description:

This method is used to implement the recursive display of child classes in the 'showChildren' method.

Type: Method          Returns: NoValue

Parameters:

1 - Integer

o showInheritance

Synopsis:
Schema ClassDescriptor showInheritance

Description:

This method displays the inheritance hierarchy for the recipient.

Type: Method          Returns: NoValue

Also Defined At:
| Object |

o showParents

Synopsis:
Schema ClassDescriptor showParents

Description:

This method displays the super class hierarchy for the recipient.

Type: Method          Returns: NoValue

o siteDescription

Synopsis:
Schema siteDescription

Description:

Returns a description of this Vision database.

Type: Method          Returns: Object

o siteName

Synopsis:
Schema siteName

Description:

Returns the name of this Vision database

Type: Constant          Returns: String

o trackDefaultValueUsing:

Synopsis:
Schema ClassDescriptor trackDefaultValueUsing: mid

Description:

This method is used to manage the default values for the class and should not be accessed directly.

Type: Method          Returns: NoValue

Parameters:

1 - Schema MessageImplementationDescriptor

o type

Synopsis:
Schema ClassDescriptor type

Description:

This property returns an instance of the class ClassType. Available types are: BuiltIn, Application, DataFeed, ToolKit, Dictionary, ObjectSpace, Other, and Unused. The initial value of type is set during instance creation using the method 'assignDefaultType'.

Type: FixedProperty          Returns: ClassType

o type

Synopsis:
Schema MessageImplementationDescriptor type

Description:

This property returns the value if the recipient's message type: Constant, FixedProperty, TimeSeriesProperty, Method, TimeVaryingMethod, or Primitive.

Type: FixedProperty          Returns: MessageType

o updateBlock

Synopsis:
Schema MessageDescriptor updateBlock

Description:

This property contains a block that could be sent to an object to update the property associated with this message.

Type: FixedProperty          Returns: Schema MessageDescriptor

o updateDate

Synopsis:
Schema MessageImplementationDescriptor updateDate

Description:

This property returns the date this message implementation was last changed.

Type: FixedProperty          Returns: Date

o updateMethod:at:with:

Synopsis:
Schema updateMethod: name at: cd with: source

Description:

This method runs as part of the 'defineMethod:' method when you provide your method definition as a text string.

Type: Method          Returns: NoValue

Parameters:

1 - String
2 - Schema ClassDescriptor
3 - String

o usageLevel

Synopsis:
Schema MessageImplementationDescriptor usageLevel

Description:

This property returns the usage level of the recipient.

Type: FixedProperty          Returns: UsageLevel

o whatAmI

Synopsis:
ToolKit whatAmI

Description:

Returns the name of the recipient's class.

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o whatAmI

Synopsis:
Schema whatAmI

Description:

Returns the name of the recipient's class.

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | String | TimeSeries | Undefined | Utility |

o whatAmI

Synopsis:
Schema Descriptor whatAmI

Description:

Returns the string "Schema Descriptor".

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o whatAmI

Synopsis:
Schema ClassDescriptor whatAmI

Description:

Returns the string "Schema ClassDescriptor".

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o whatAmI

Synopsis:
Schema MessageDescriptor whatAmI

Description:

Returns the string "Schema MessageDescriptor".

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

o whatAmI

Synopsis:
Schema MessageImplementationDescriptor whatAmI

Description:

Returns the string "Schema MessageImplementationDescriptor" .

Type: Constant          Returns: String

Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

Related Topics