Vision Messages: Utility

| Home | Utility Class | Message XRef | Messages (General) |

Profile of Class Utility


Object
  | 
  +--- Utility

The Utility class is used to organize various messages that perform utility functions.

Message Index

o SessionAttribute
o UnixSeconds
o asSelf
o basicUpdateNetwork
o classDescriptor
o collectGarbage
o defaultInstance
o echoToFile: fileName
o faultSeverities
o fullCompact
o fullCompactExcept: spaceList
o fullCompactOf: spaceList
o isUtility
o stopEchoToFile
o systemErrorCount
o systemWarningCount
o updateAndCompact
o updateAndCompactNetworkAsBaseVersionWithAnnotation: aString
o updateAndCompactNetworkWithAnnotation: aString
o updateNetwork
o updateNetworkAsBaseVersionWithAnnotation: aString
o updateNetworkWithAnnotation: aString
o whatAmI

Messages

o SessionAttribute

Synopsis:
Utility SessionAttribute

Description:

Supports parameterized control of session update properties.

Type: Constant          Returns: Utility SessionAttribute

o UnixSeconds

Synopsis:
Utility UnixSeconds

Description:

Returns the Utility UnixSeconds class.

Type: Constant           Returns: Utility UnixSeconds

o asSelf

Synopsis:
Utility asSelf

Description:

Returns the default Utility instance.

Type: Primitive           Returns: Utility

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

o basicUpdateNetwork

Synopsis:
Utility basicUpdateNetwork

Description:

Primitive version of object space update message.

Type: Primitive          Returns: Object

o classDescriptor

Synopsis:
Utility 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 | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined |

o collectGarbage

Synopsis:
Utility collectGarbage

Description:

Initiates network Garbage Collection process.

Type: Primitive          Returns: Object

o defaultInstance

Synopsis:
Utility defaultInstance

Description:

Returns the default instance of the recipient object's class

Type: Constant          Returns: Utility

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

o echoToFile:

Synopsis:
Utility echoToFile: fileName

Description:

Opens the supplied file name for output. All subsequent output is displayed on standard output and in this file until the 'stopEchoToFile' message is encountered.

Type: Primitive          Returns: Object

o faultSeverities

Synopsis:
Utility faultSeverities

Type: Primitive          Returns: Object

o fullCompact

Synopsis:
Utility fullCompact

Description:

Compacts all spaces performing the copy and base version phases and generating all traces.

Type: Method          Returns: Object

o fullCompactExcept:

Synopsis:
Utility fullCompactExcept: spaceList

Description:

Compacts all spaces except those in supplied list performing the copy and base version phases and generating all traces.

Type: Method          Returns: Object

o fullCompactOf:

Synopsis:
Utility fullCompactOf: spaceList

Description:

Compacts all spaces in supplied list performing the copy and base version phases and generating all traces.

Type: Method          Returns: Object

o isUtility

Synopsis:
Utility isUtility

Description:

Returns the value TRUE when sent to Utility.

Type: Constant          Returns: Boolean

Also Defined At:
| Object |

o stopEchoToFile

Synopsis:
Utility stopEchoToFile

Description:

Closes the file currently open for output. All output continues to display on the standard output.

Type: Primitive          Returns: Object

o systemErrorCount

Synopsis:
Utility systemErrorCount

Description:

Returns Number of 'hard' errors encountered during current session.

Type: Method          Returns: Integer

o systemWarningCount

Synopsis:
Utility systemWarningCount

Description:

Returns Number of 'warning' errors encountered during current session.

Type: Method          Returns: Integer

o updateAndCompact

Synopsis:
Utility updateAndCompact

Description:

Performs the update and the copy phase of the compaction process, with no special annotation.

Type: Method          Returns: Object

o updateAndCompactNetworkAsBaseVersionWithAnnotation:

Synopsis:
Utility updateAndCompactNetworkAsBaseVersionWithAnnotation: aString

Description:

Performs network update and the copy and base version phases of the compaction process, saving the supplied annotation in the NDF.

Type: Method          Returns: Object

Parameters:

1 - String

o updateAndCompactNetworkWithAnnotation:

Synopsis:
Utility updateAndCompactNetworkWithAnnotation: aString

Description:

Performs network update and the copy phase of the compaction process, saving the supplied annotation in the NDF.

Type: Method          Returns: Object

Parameters:

1 - String

o updateNetwork

Synopsis:
Utility updateNetwork

Description:

Updates the network with data and protocol defined during this session. Depending on type of user, the update may be global or private.

Type: Method          Returns: Object

o updateNetworkAsBaseVersionWithAnnotation:

Synopsis:
Utility updateNetworkAsBaseVersionWithAnnotation: aString

Description:

Performs network update and the base version phase of the compaction process, saving the supplied annotation in the NDF.

Type: Method          Returns: Object

Parameters:

1 - String

o updateNetworkWithAnnotation:

Synopsis:
Utility updateNetworkWithAnnotation: aString

Description:

Performs network update and saves the supplied string in the ndf.

Type: Method          Returns: Object

Parameters:

1 - String

o whatAmI

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