Recent changes to Log

Log modified by Barry Goodsell

Barry Goodsell — Wed, 21 May 2014 15:25:17 -0000

--- v9
+++ v10
@@ -1,4 +1,5 @@
-Package [com.oaframework.toolkit.util](:Category:Utilities) 
+# Log
+Package [com.oaframework.toolkit.common.util]

 All of the public methods in this class (except for [event()](#event())) are overloaded to provide logging from the following types of objects: 

@@ -101,5 +102,3 @@
         Log.endProcedure(this);
       }
     }
-
-[Category:Utilities]

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:28 -0000

--- v8
+++ v9
@@ -35,7 +35,7 @@

 ## isEnabled()

-Returns {{Boolean:true}} [true](Wikipedia:Boolean_datatype#Java) if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 
+Returns {{Boolean|true}} if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 

     public static boolean isEnabled(OAApplicationModuleImpl am, int logLevel)
     public static boolean isEnabled(OAViewObjectImpl vo, int logLevel)

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:28 -0000

--- v7
+++ v8
@@ -35,7 +35,7 @@

 ## isEnabled()

-Returns [true](Wikipedia:Boolean_datatype#Java) if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 
+Returns {{Boolean:true}} [true](Wikipedia:Boolean_datatype#Java) if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 

     public static boolean isEnabled(OAApplicationModuleImpl am, int logLevel)
     public static boolean isEnabled(OAViewObjectImpl vo, int logLevel)

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:28 -0000

--- v6
+++ v7
@@ -35,7 +35,7 @@

 ## isEnabled()

-Returns TRUE if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 
+Returns [true](Wikipedia:Boolean_datatype#Java) if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types: 

     public static boolean isEnabled(OAApplicationModuleImpl am, int logLevel)
     public static boolean isEnabled(OAViewObjectImpl vo, int logLevel)

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:28 -0000

--- v5
+++ v6
@@ -101,3 +101,5 @@
         Log.endProcedure(this);
       }
     }
+
+[Category:Utilities]

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:28 -0000

--- v4
+++ v5
@@ -1,11 +1,24 @@
 Package [com.oaframework.toolkit.util](:Category:Utilities)

-All of the public methods in this class (except for **event()** are overloaded to provide logging from the following types of objects: 
+All of the public methods in this class (except for [event()](#event())) are overloaded to provide logging from the following types of objects: 

   * OAApplicationModuleImpl 
   * OAViewObjectImpl 
   * OAViewRowImpl 
   * OAPageContext (ie: a Page Controller) 
+
+Before Logging can work correctly, the Profile Options **FND: Diagnostics** and **FND: Debug Log Enabled** must be set to **Yes**. The level of detail for the Log is determined by the **FND: Debug Log Level** Profile Option, which can take the values of one of the constants defined below. Finally, it is possible to restrict which modules produce Logging data by setting the **FND: Debug Log Module** Profile Option. For OA Framework this would be the class name of the class to be monitored and can include **%** wildcards. 
+
+In JDeveloper, it is possible to enable logging when running against the Embedded OC4J Server by adding the following parameters on the _Runtime Connection_ page of the _Project Settings_: 
+    
+    &aflog_level=<level>&aflog_module=<module>
+
+For example: 
+    
+    &aflog_level=STATEMENT&aflog_module=XXX*
+
+Note that ***** is used as the wildcard when used on the URL command line, as **%** is a special character. 
+
 [TOC]

 ## Public Constants

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:27 -0000

--- v3
+++ v4
@@ -64,7 +64,7 @@

 ## Example

-The following example shows how the **Log** class can be used in a View Object, but the same principles can be applied to the other supported object types. 
+The following simplified example shows how the **Log** class can be used in a View Object, but the same principles can be applied to the other supported object types. 

     import com.oaframework.toolkit.util.Log;
     import oracle.apps.fnd.framework.server.OAViewObjectImpl;

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:27 -0000

--- v2
+++ v3
@@ -64,7 +64,7 @@

 ## Example

-The following example shows how the **Log** class can be used in a View Object, but the same prinicples can be applied to the other supported object types. 
+The following example shows how the **Log** class can be used in a View Object, but the same principles can be applied to the other supported object types. 

     import com.oaframework.toolkit.util.Log;
     import oracle.apps.fnd.framework.server.OAViewObjectImpl;

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:27 -0000

--- v1
+++ v2
@@ -61,3 +61,30 @@
 If logging is enabled at EVENT level, writes a message to the log identifiying the current User Interface Event ([UiEvent]).

     public static void event (OAPageContext pc, UiEvent evt)
+
+## Example
+
+The following example shows how the **Log** class can be used in a View Object, but the same prinicples can be applied to the other supported object types. 
+    
+    import com.oaframework.toolkit.util.Log;
+    import oracle.apps.fnd.framework.server.OAViewObjectImpl;
+    import oracle.jbo.domain.Number;
+    
+    public class ListRecordsVOImpl extends OAViewObjectImpl
+    {
+      public ListRecordsVOImpl()
+      {
+      }
+    
+      public void initQuery(Number recordId)
+      {
+        Log.startProcedure(this);
+        Log.write(this, "RecordId = " + recordId, Log.STATEMENT);
+        
+        setWhereClauseParams(null);
+        setWhereClauseParam(0, recordId);
+        executeQuery();
+        
+        Log.endProcedure(this);
+      }
+    }

Log modified by Barry Goodsell

Barry Goodsell — Tue, 20 May 2014 14:16:27 -0000

Package com.oaframework.toolkit.util

All of the public methods in this class (except for event() are overloaded to provide logging from the following types of objects:

OAApplicationModuleImpl
OAViewObjectImpl
OAViewRowImpl
OAPageContext (ie: a Page Controller)
[TOC]

Public Constants

These constants define the various logging levels:

UNEXPECTED
ERROR
EXCEPTION
EVENT
PROCEDURE
STATEMENT
PERFORMANCE

isEnabled()

Returns TRUE if logging is enabled at the specified level for the supplied object. The method has four overloads to support different object types:

public static boolean isEnabled(OAApplicationModuleImpl am, int logLevel)
public static boolean isEnabled(OAViewObjectImpl vo, int logLevel)
public static boolean isEnabled(OAViewRowImpl vor, int logLevel)
public static boolean isEnabled(OAPageContext pc, int logLevel)

startProcedure()

If logging is enabled at PROCEDURE level for the supplied object, a message is written to the log to indicate that the current method has started. The method has four overloads to support different object types:

public static void startProcedure(OAApplicationModuleImpl am)
public static void startProcedure(OAViewObjectImpl vo)
public static void startProcedure(OAViewRowImpl vor)
public static void startProcedure(OAControllerImpl cnt, OAPageContext pc)

endProcedure()

If logging is enabled at PROCEDURE level for the supplied object, a message is written to the log to indicate that the current method has ended. The method has four overloads to support different object types:

public static void endProcedure(OAApplicationModuleImpl am)
public static void endProcedure(OAViewObjectImpl vo)
public static void endProcedure(OAViewRowImpl vor)
public static void endProcedure(OAControllerImpl cnt, OAPageContext pc)

write()

If logging is enabled at the specified level, writes the supplied message to the log. The method has four overloads to support different object types:

public static void write (OAApplicationModuleImpl am, String msg, int logLevel)
public static void write (OAViewObjectImpl vo, String msg, int logLevel)
public static void write (OAViewRowImpl vor, String msg, int logLevel)
public static void write (OAPageContext pc, String msg, int logLevel)

event()

If logging is enabled at EVENT level, writes a message to the log identifiying the current User Interface Event ([UiEvent]).

public static void event (OAPageContext pc, UiEvent evt)