log Class Reference

Inheritance diagram for log:

Collaboration diagram for log:

Public Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnNew (_.Library.RawString logFile, _.Library.Boolean initialize)
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
	logError (_.SYSTEM.Error error)
	logStatus (_.Library.Status StatusCode, _.Library.String Message, Outcome)
	logStream (_.Stream.Object stream, _.Library.Integer pNumbered)
_.Library.Status	write (_.Library.String message, _.Library.Integer linesBefore, _.Library.Integer linesAfter)
	write() - write a message to the current log file
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.Status	traceError (_.SYSTEM.Error pError)
	traceStatus (_.Library.Status StatusCode, _.Library.String Message, Outcome)

Public Attributes
	logFile
	More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Member Function Documentation

OnClose()

_.Library.Status OnClose

(

)

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

OnNew()

_.Library.Status OnNew	(	_.Library.RawString	logFile,
		_.Library.Boolean	initialize
	)

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status

logError()

logError

(

_.SYSTEM.Error

error

)

Report an error from a SYSTEM.Error object

• error - an instance of SYSTEM.Error

logStatus()

logStatus	(	_.Library.Status	StatusCode,
		_.Library.String	Message,
			Outcome
	)

Report a status message from a trace

• sc - pass as status code

• message - pass a message to be written both to the current device and to the log (or "") (optional)

• outcome - pass an array of stats (optional)

logStream()

logStream	(	_.Stream.Object	stream,
		_.Library.Integer	pNumbered
	)

Copy the contents of a stream to the log

• stream - stream to copy to the file.

traceError()

_.Library.Status traceError ( _.SYSTEM.Error  pError )

static

Report an error from a SYSTEM.Error object

• error - an instance of SYSTEM.Error

traceStatus()

traceStatus ( _.Library.Status  StatusCode, _.Library.String  Message,   Outcome  )

static

Report a status message from a trace

• sc - pass as status code

• message - pass a message to be written both to the current device and to the log (or "") (optional)

• outcome - pass an array of stats (optional)

Member Data Documentation

logFile

logFile