01: package org.drools.reteoo;
02:
03: /*
04: * Copyright 2005 JBoss Inc
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: */
18:
19: import org.drools.common.InternalFactHandle;
20: import org.drools.common.InternalWorkingMemory;
21: import org.drools.spi.PropagationContext;
22:
23: /**
24: * Receiver of propagated <code>FactHandleImpl</code>s from a
25: * <code>ObjectSource</code>.
26: *
27: * @see ObectSource
28: *
29: * @author <a href="mailto:mark.proctor@jboss.com">Mark Proctor</a>
30: * @author <a href="mailto:bob@werken.com">Bob McWhirter</a>
31: *
32: */
33: public interface ObjectSink extends Sink {
34:
35: /**
36: * Assert a new <code>FactHandleImpl</code>.
37: *
38: * @param handle
39: * The asserted <code>FactHandle/code>.
40: * @param context
41: * The <code>PropagationContext</code> of the <code>WorkingMemory<code> action.
42: * @param workingMemory
43: * the <code>WorkingMemory</code> session.
44: */
45: void assertObject(InternalFactHandle handle,
46: PropagationContext context,
47: InternalWorkingMemory workingMemory);
48:
49: /**
50: * Retract an existing <code>FactHandleImpl</code>.
51: *
52: * @param handle
53: * The <code>FactHandle/code> to retract.
54: * @param context
55: * The <code>PropagationContext</code> of the <code>WorkingMemory<code> action.
56: * @param workingMemory
57: * the <code>WorkingMemory</code> session.
58: */
59: void retractObject(InternalFactHandle handle,
60: PropagationContext context,
61: InternalWorkingMemory workingMemory);
62: }
|