mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
8c2c15c5c9
An action parameter constraint provides a way to list the valid values that an action or action constraint parameter can take. This means more information about the action or action condition is available to the user of the action. Currently there is only an implementation for enum parameter values, but this will be extended as the existing action implementations are reviewed and value constraints are added as required. The REST API can now be extended to provide this additional information. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18489 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
118 lines
3.9 KiB
Java
118 lines
3.9 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.action;
|
|
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.repo.action.evaluator.ActionConditionEvaluator;
|
|
import org.alfresco.repo.action.executer.ActionExecuter;
|
|
import org.alfresco.service.cmr.action.Action;
|
|
import org.alfresco.service.cmr.action.ParameterConstraint;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* Runtime action service. This interface contains methods useful for integration with the action
|
|
* service at a lower level.
|
|
*
|
|
* @author Roy Wetherall
|
|
*/
|
|
public interface RuntimeActionService
|
|
{
|
|
/**
|
|
* Post commit method
|
|
*/
|
|
void postCommit();
|
|
|
|
/**
|
|
* Register an action condition evaluator
|
|
*
|
|
* @param actionConditionEvaluator action condition evaluator
|
|
*/
|
|
void registerActionConditionEvaluator(ActionConditionEvaluator actionConditionEvaluator);
|
|
|
|
/**
|
|
* Register an action executer
|
|
*
|
|
* @param actionExecuter action executer
|
|
*/
|
|
void registerActionExecuter(ActionExecuter actionExecuter);
|
|
|
|
/**
|
|
* Register parameter constraint
|
|
*
|
|
* @param parameterConstraint parameter constraint
|
|
*/
|
|
void registerParameterConstraint(ParameterConstraint parameterConstraint);
|
|
|
|
/**
|
|
* Create a new action based on an action node reference
|
|
*
|
|
* @param actionNodeRef action node reference
|
|
* @return Action action object
|
|
*/
|
|
Action createAction(NodeRef actionNodeRef);
|
|
|
|
/**
|
|
* Create a action node reference
|
|
*
|
|
* @param action action object
|
|
* @param parentNodeRef parent node reference
|
|
* @param assocTypeName association type name
|
|
* @param assocName association name
|
|
* @return NodeRef created node reference
|
|
*/
|
|
NodeRef createActionNodeRef(Action action, NodeRef parentNodeRef, QName assocTypeName, QName assocName);
|
|
|
|
/**
|
|
* Save action, used internally to store the details of an action on the aciton node.
|
|
*
|
|
* @param actionNodeRef the action node reference
|
|
* @param action the action
|
|
*/
|
|
void saveActionImpl(NodeRef actionNodeRef, Action action);
|
|
|
|
/**
|
|
*
|
|
* @param action
|
|
* @param actionedUponNodeRef
|
|
* @param checkConditions
|
|
*/
|
|
public void executeActionImpl(
|
|
Action action,
|
|
NodeRef actionedUponNodeRef,
|
|
boolean checkConditions,
|
|
boolean executedAsynchronously,
|
|
Set<String> actionChain);
|
|
|
|
/**
|
|
* Execute an action directly
|
|
*
|
|
* @param action the action
|
|
* @param actionedUponNodeRef the actioned upon node reference
|
|
*/
|
|
public void directActionExecution(Action action, NodeRef actionedUponNodeRef);
|
|
}
|