[jboss-svn-commits] JBL Code SVN: r33143 - labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime.

[jboss-svn-commits at lists.jboss.org]

Author: tirelli
Date: 2010-05-28 11:35:02 -0400 (Fri, 28 May 2010)
New Revision: 33143

Added:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/Channel.java
Log:
JBRULES-2525: adding Channel class... missed it on my last commit

Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/Channel.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/Channel.java	                        (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/Channel.java	2010-05-28 15:35:02 UTC (rev 33143)
@@ -0,0 +1,36 @@
+package org.drools.runtime;
+
+/**
+ * <p>
+ * A channel provides a mechanism to send objects from the working memory to some external process 
+ * or function.  For instance, a channel can be used to inform some piece of code that an object 
+ * matches a rule.  
+ * </p>
+ *
+ * <p>
+ * To create a channel, implement the interface and register it with the KnowledgeRuntime:
+ * </p>
+ * <pre>
+ * ...
+ * ksession.registerChannel("my-channel", new MyChannelImpl());
+ * </pre>
+ * 
+ * <p>
+ * Channels are invoked from the consequence side of a rule:
+ * </p>
+ * <pre>
+ * when
+ *   ...
+ * then
+ *   channels["my-channel"].send(...);
+ * </pre>
+ */
+public interface Channel {
+
+    /**
+     * Sends the given object to this channel.
+     * 
+     * @param object
+     */
+    void send(Object object);
+}


Property changes on: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/Channel.java
___________________________________________________________________
Name: svn:executable
   + *