documentation

Author: rsoika

imixs-workflow-engine/src/main/java/org/imixs/workflow/engine/EventLogService.java

@@ -86,8 +86,8 @@ public class EventLogService {
     /**
      * Creates/updates a new event log entry.
      * 
-     * @param refID - uniqueid of the document to be assigned to the event
      * @param topic - the topic of the event.
+     * @param refID - uniqueId of the workitem assigned to the event
      * @return - generated event log entry
      */
     public EventLog createEvent(String topic, String refID) {
@@ -97,8 +97,8 @@ public EventLog createEvent(String topic, String refID) {
     /**
      * Creates/updates a new event log entry.
      * 
-     * @param refID   - uniqueid of the document to be assigned to the event
      * @param topic   - the topic of the event.
+     * @param refID   - uniqueId of the workitem assigned to the event
      * @param timeout - optional timeout calendar object
      * @return - generated event log entry
      */
@@ -109,8 +109,8 @@ public EventLog createEvent(String topic, String refID, Calendar timeout) {
     /**
      * Creates/updates a new event log entry.
      *
-     * @param refID    - uniqueId of the document to be assigned to the event
      * @param topic    - the topic of the event.
+     * @param refID    - uniqueId of the workitem assigned to the event
      * @param document - optional document providing a data map
      * @return - generated event log entry
      */
@@ -121,8 +121,8 @@ public EventLog createEvent(String topic, String refID, ItemCollection document)
     /**
      * Creates/updates a new event log entry.
      *
-     * @param refID    - uniqueId of the document to be assigned to the event
      * @param topic    - the topic of the event.
+     * @param refID    - uniqueId of the workitem assigned to the event
      * @param document - optional document providing a data map
      * @param timeout  - optional timeout calendar object
      * @return - generated event log entry
@@ -134,9 +134,10 @@ public EventLog createEvent(String topic, String refID, ItemCollection document,
     /**
      * Creates/updates a new event log entry.
      *
-     * @param refID - uniqueId of the document to be assigned to the event
-     * @param topic - the topic of the event.
-     * @param data  - optional data map
+     * @param topic   - the topic of the event.
+     * @param refID   - uniqueId of the workitem assigned to the event
+     * @param data    - optional data map
+     * @param timeout - optional timeout calendar object
      * @return - generated event log entry
      */
     public EventLog createEvent(String topic, String refID, Map<String, List<Object>> data, Calendar timeout) {

src/site/markdown/engine/eventlogservice.md

@@ -17,7 +17,7 @@ The service is bound to the current PersistenceContext and stores a EventLog ent
     EventLogService eventLogService;
     ....
         // BEGIN Transaction A
-    	eventLogService.createEvent(workitem.getUniqueID(), "MY_TOPIC");
+    	eventLogService.createEvent("MY_TOPIC", workitem.getUniqueID());
     ....
         // END Transaction A
     .......