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 pError)
	logFunction (_.Library.String pName, _.Library.String pValue)
_.Library.Status	logSQLCODE (_.Library.Integer pSQLCODE, _.Library.String pMessage, _.Library.String pPrefix)
_.Library.Status	logStatementResult (_.SQL.StatementResult pResult)
	Log the contents of a SQL.StatementResult object.
_.Library.Status	logStatementSource (_.Library.Integer pBatchNumber, _.Library.String pSource, _.Library.Integer pLinesBefore, _.Library.Integer pLinesAfter)
	Log SQL statement source.
_.Library.Integer	logStatus (_.Library.Status StatusCode, _.Library.String Message, Outcome)
	logStream (_.Stream.Object stream, _.Library.Integer pNumbered)
	logValue (_.Library.String pName, _.Library.String pValue)
_.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.Integer	ActivateLog ()
	ActivateLog (also called as a procedure - CALL InSync_SYS.activate_log()) will set the trace switch. More...
_.Library.Integer	DeactivateLog ()
	DeactivateLog (also callable as a procedure - CALL InSync_SYS.deactivate_log()) will turn of the trace. More...
_.Library.Status	traceEmbeddedSQL (_.Library.String pStatement, _.Library.Integer pSQLCODE, _.Library.String pMsg, _.Library.Integer pROWCOUNT, _.Library.Numeric pTime, _.Library.String pArguments)
_.Library.Status	traceError (_.SYSTEM.Error pError)
	traceException (_.Exception.AbstractException pException, _.Library.String pPrefix)
	traceFunction (_.Library.String pName, _.Library.String pValue)
_.Library.Status	traceSQLCODE (_.Library.Integer pSQLCODE, _.Library.String pMessage, _.Library.String pPrefix)
	traceStatus (_.Library.Status StatusCode, _.Library.String Message, Outcome)
	traceValue (_.Library.String pName, _.Library.String pValue)

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

ActivateLog()

_.Library.Integer ActivateLog ( )

static

ActivateLog (also called as a procedure - CALL InSync_SYS.activate_log()) will set the trace switch.

to begin logging. Messages logged using $$$TRACE macros will be written to the log file.

DeactivateLog()

_.Library.Integer DeactivateLog ( )

static

DeactivateLog (also callable as a procedure - CALL InSync_SYS.deactivate_log()) will turn of the trace.

switch so that $$$TRACE macros will not longer be written to the log file. The log file is also closed.

logError()

logError

(

_.SYSTEM.Error

pError

)

Report an error from a SYSTEM.Error object

• pError - an instance of SYSTEM.Error

logFunction()

logFunction	(	_.Library.String	pName,
		_.Library.String	pValue
	)

Report a function and its return value.

• pName - the name of the value, for example, 'pFormal1' as the name of a formal argument

• pValue - the value

logSQLCODE()

_.Library.Status logSQLCODE	(	_.Library.Integer	pSQLCODE,
		_.Library.String	pMessage,
		_.Library.String	pPrefix
	)

Log an SQLCODE and msg value

• pSQLCODE - the SQLCODE value

• pMessage - the msg value

• pPrefix - the prefix to use when writing the log content, defaults to two tab characters.

logStatus()

_.Library.Integer 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.

logValue()

logValue	(	_.Library.String	pName,
		_.Library.String	pValue
	)

Report a named value

• pName - the name of the value, for example, 'pFormal1' as the name of a formal argument

• pValue - the value

traceEmbeddedSQL()

_.Library.Status traceEmbeddedSQL ( _.Library.String  pStatement, _.Library.Integer  pSQLCODE, _.Library.String  pMsg, _.Library.Integer  pROWCOUNT, _.Library.Numeric  pTime, _.Library.String  pArguments  )

static

Report a execution of embedded/deferred SQL, its arguments, and status.

• pStatement - the text of the SQL Statement executed

• pArguments - the Arguments and their values

• pSQLCODE - the resulting SQLCODE

• pMsg - the resuting msg (if any)

• pROWCOUNT - the resulting ROWCOUNT (if any)

• pTime - the execution time (if any)

traceError()

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

static

Report an error from a SYSTEM.Error object

• error - an instance of SYSTEM.Error

traceException()

traceException ( _.Exception.AbstractException  pException, _.Library.String  pPrefix  )

static

Report an exception from a trace

• pException - pass as an exception oref

traceFunction()

traceFunction ( _.Library.String  pName, _.Library.String  pValue  )

static

Report a function and its return value.

• pName - the name of the function method

• pValue - the return value

traceSQLCODE()

_.Library.Status traceSQLCODE ( _.Library.Integer  pSQLCODE, _.Library.String  pMessage, _.Library.String  pPrefix  )

static

Log an SQLCODE and msg value

• pSQLCODE - the SQLCODE value

• pMessage - the msg value

• pPrefix - the prefix to use when writing the log content, defaults to two tab characters.

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)

traceValue()

traceValue ( _.Library.String  pName, _.Library.String  pValue  )

static

Report a named value

• pName - the name of the value, for example, 'pFormal1' as the name of a formal argument

• pValue - the value

Member Data Documentation

logFile

logFile