mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Moving to root below branch label
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
56
source/java/org/alfresco/service/cmr/rule/Rule.java
Normal file
56
source/java/org/alfresco/service/cmr/rule/Rule.java
Normal file
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
|
||||
package org.alfresco.service.cmr.rule;
|
||||
|
||||
import org.alfresco.service.cmr.action.CompositeAction;
|
||||
|
||||
|
||||
/**
|
||||
* Rule Interface
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public interface Rule extends CompositeAction
|
||||
{
|
||||
/**
|
||||
* Indicates that the rule is applied to the children of the associated
|
||||
* node, not just the node itself.
|
||||
* <p>
|
||||
* By default this will be set to false.
|
||||
*
|
||||
* @return true if the rule is applied to the children of the associated node,
|
||||
* false otherwise
|
||||
*/
|
||||
boolean isAppliedToChildren();
|
||||
|
||||
/**
|
||||
* Set whether the rule is applied to all children of the associated node
|
||||
* rather than just the node itself.
|
||||
*
|
||||
* @param isAppliedToChildren true if the rule should be applied to the children, false
|
||||
* otherwise
|
||||
*/
|
||||
void applyToChildren(boolean isAppliedToChildren);
|
||||
|
||||
/**
|
||||
* Get the rule type name
|
||||
*
|
||||
* @return the rule type name
|
||||
*/
|
||||
String getRuleTypeName();
|
||||
}
|
||||
175
source/java/org/alfresco/service/cmr/rule/RuleService.java
Normal file
175
source/java/org/alfresco/service/cmr/rule/RuleService.java
Normal file
@@ -0,0 +1,175 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.rule;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
/**
|
||||
* Rule service interface.
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public interface RuleService
|
||||
{
|
||||
/**
|
||||
* Get the rule types currently defined in the repository.
|
||||
*
|
||||
* @return a list of rule types
|
||||
*/
|
||||
public List<RuleType> getRuleTypes();
|
||||
|
||||
/**
|
||||
* Gets a rule type by name.
|
||||
*
|
||||
* @param name the name of the rule type
|
||||
* @return the rule type, null if not found
|
||||
*/
|
||||
public RuleType getRuleType(String name);
|
||||
|
||||
/**
|
||||
* Indicates wether the rules for a given node are enabled or not. If the
|
||||
* rules are not enabled then they will not be executed.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @return true if the rules are enabled, false otherwise
|
||||
*/
|
||||
public boolean rulesEnabled(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Disables the rules for a given node reference. When the rules are disabled they
|
||||
* will not execute.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
*/
|
||||
public void disableRules(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Enables the rules for a given node reference. When the rules are enabled they
|
||||
* will execute as usual. By default all rules are enabled.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
*/
|
||||
public void enableRules(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Disables a rule, preventing it from being fired.
|
||||
*
|
||||
* @param rule the rule to disable
|
||||
*/
|
||||
public void disableRule(Rule rule);
|
||||
|
||||
/**
|
||||
* Enables a rule previously disabled.
|
||||
*
|
||||
* @param rule the rule to enable
|
||||
*/
|
||||
public void enableRule(Rule rule);
|
||||
|
||||
/**
|
||||
* Indicates whether the node in question has any rules associated with it.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @return true if the node has rules associated, false otherwise
|
||||
*/
|
||||
public boolean hasRules(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Get all the rules associated with an actionable node, including those
|
||||
* inherited from parents.
|
||||
* <p>
|
||||
* An exception is raised if the actionable aspect is not present on the
|
||||
* passed node.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @return a list of the rules associated with the node
|
||||
*/
|
||||
public List<Rule> getRules(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Get the rules associated with an actionable node.
|
||||
* <p>
|
||||
* Optionally this list includes rules inherited from its parents.
|
||||
* <p>
|
||||
* An exception is raised if the actionable aspect is not present on the
|
||||
* passed node.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @param includeInhertied indicates whether the inherited rules should be included in
|
||||
* the result list or not
|
||||
* @return a list of the rules associated with the node
|
||||
*/
|
||||
public List<Rule> getRules(NodeRef nodeRef, boolean includeInhertied);
|
||||
|
||||
/**
|
||||
* Get the rules associatied with an actionable node that are of a specific rule type.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @param includeInhertiedRuleType indicates whether the inherited rules should be included in
|
||||
* the result list or not
|
||||
* @param ruleTypeName the name of the rule type, if null is passed all rule types
|
||||
* are returned
|
||||
* @return a list of the rules associated with the node
|
||||
*/
|
||||
public List<Rule> getRules(NodeRef nodeRef, boolean includeInhertiedRuleType, String ruleTypeName);
|
||||
|
||||
/**
|
||||
* Get the rule given its id.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @param ruleId the rule id
|
||||
* @return the rule corresponding ot the id
|
||||
*/
|
||||
public Rule getRule(NodeRef nodeRef, String ruleId);
|
||||
|
||||
/**
|
||||
* Helper method to create a new rule.
|
||||
* <p>
|
||||
* Call add rule once the details of the rule have been specified in order
|
||||
* to associate the rule with a node reference.
|
||||
*
|
||||
* @param ruleTypeName the name of the rule type
|
||||
* @return the created rule
|
||||
*/
|
||||
public Rule createRule(String ruleTypeName);
|
||||
|
||||
/**
|
||||
* Saves the details of the rule to the specified node reference.
|
||||
* <p>
|
||||
* If the rule is already associated with the node, the details are updated
|
||||
* with those specified.
|
||||
*
|
||||
* @param nodeRef
|
||||
* @param rule
|
||||
*/
|
||||
public void saveRule(NodeRef nodeRef, Rule rule);
|
||||
|
||||
/**
|
||||
* Removes a rule from the given rule actionable node
|
||||
*
|
||||
* @param nodeRef the actionable node reference
|
||||
*/
|
||||
public void removeRule(NodeRef nodeRef, Rule rule);
|
||||
|
||||
/**
|
||||
* Removes all the rules associated with an actionable node
|
||||
*
|
||||
* @param nodeRef the actionable node reference
|
||||
*/
|
||||
public void removeAllRules(NodeRef nodeRef);
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.rule;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
|
||||
/**
|
||||
* Rule Service Exception Class
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public class RuleServiceException extends AlfrescoRuntimeException
|
||||
{
|
||||
/**
|
||||
* Serial version UID
|
||||
*/
|
||||
private static final long serialVersionUID = 3257571685241467958L;
|
||||
|
||||
/**
|
||||
* Construtor
|
||||
*
|
||||
* @param message the message string
|
||||
*/
|
||||
public RuleServiceException(String message)
|
||||
{
|
||||
super(message);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param message the message string
|
||||
* @param source the source exception
|
||||
*/
|
||||
public RuleServiceException(String message, Throwable source)
|
||||
{
|
||||
super(message, source);
|
||||
}
|
||||
}
|
||||
58
source/java/org/alfresco/service/cmr/rule/RuleType.java
Normal file
58
source/java/org/alfresco/service/cmr/rule/RuleType.java
Normal file
@@ -0,0 +1,58 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.rule;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
|
||||
/**
|
||||
* Rule type interface.
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public interface RuleType
|
||||
{
|
||||
/**
|
||||
* Some rule type constants
|
||||
*/
|
||||
public static final String INBOUND = "inbound";
|
||||
public static final String OUTGOING = "outgoing";
|
||||
|
||||
/**
|
||||
* Get the name of the rule type.
|
||||
* <p>
|
||||
* The name is unique and is used to identify the rule type.
|
||||
*
|
||||
* @return the name of the rule type
|
||||
*/
|
||||
public String getName();
|
||||
|
||||
/**
|
||||
* Get the display label of the rule type.
|
||||
*
|
||||
* @return the display label
|
||||
*/
|
||||
public String getDisplayLabel();
|
||||
|
||||
/**
|
||||
* Trigger the rules of the rule type for the node on the actioned upon node.
|
||||
*
|
||||
* @param nodeRef the node ref whos rule of rule type are to be triggered
|
||||
* @param actionedUponNodeRef the node ref that the triggered rule will action upon
|
||||
*/
|
||||
public void triggerRuleType(NodeRef nodeRef, NodeRef actionedUponNodeRef);
|
||||
}
|
||||
Reference in New Issue
Block a user