KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > rule > RuleType


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.service.cmr.rule;
18
19 import org.alfresco.service.cmr.repository.NodeRef;
20
21
22 /**
23  * Rule type interface.
24  *
25  * @author Roy Wetherall
26  */
27 public interface RuleType
28 {
29     /**
30      * Some rule type constants
31      */
32     public static final String JavaDoc INBOUND = "inbound";
33     public static final String JavaDoc OUTGOING = "outgoing";
34     
35     /**
36      * Get the name of the rule type.
37      * <p>
38      * The name is unique and is used to identify the rule type.
39      *
40      * @return the name of the rule type
41      */
42     public String JavaDoc getName();
43     
44     /**
45      * Get the display label of the rule type.
46      *
47      * @return the display label
48      */
49     public String JavaDoc getDisplayLabel();
50
51     /**
52      * Trigger the rules of the rule type for the node on the actioned upon node.
53      *
54      * @param nodeRef the node ref whos rule of rule type are to be triggered
55      * @param actionedUponNodeRef the node ref that the triggered rule will action upon
56      */
57     public void triggerRuleType(NodeRef nodeRef, NodeRef actionedUponNodeRef);
58 }
Popular Tags