org.alfresco.repo.webservice.action

Class ActionWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.action.ActionWebService

All Implemented Interfaces:

Remote, ActionServiceSoapPort

public class ActionWebService
extends AbstractWebService
implements ActionServiceSoapPort

Action web service implementation

Author:

Roy Wetherall

Field Summary

Fields inherited from class org.alfresco.repo.webservice.AbstractWebService

contentService, namespaceService, nodeService, querySessionCache, searchService, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
ActionWebService()

Method Summary

Methods

Modifier and Type	Method and Description
ActionExecutionResult[]	executeActions(Predicate predicate, Action[] webServiceActions) Executes actions.
ActionExecutionResult[]	executeActionsImpl(Predicate predicate, Action[] webServiceActions) Execute actions implementation
ActionItemDefinition[]	getActionDefinitions() Gets the available action definitions.
ActionItemDefinition	getActionItemDefinition(String name, ActionItemDefinitionType definitionType) Get a named action item definition.
ActionItemDefinition	getActionItemDefinitionImpl(String name, ActionItemDefinitionType definitionType)
Action[]	getActions(Reference reference, ActionFilter filter) Gets the actions saved against a reference.
ActionItemDefinition[]	getConditionDefinitions() Gets the available condition definitions.
Rule[]	getRules(Reference reference, RuleFilter ruleFilter) Gets the rules for a reference.
RuleType	getRuleType(String name) Get a named rule type.
RuleType	getRuleTypeImpl(String name)
RuleType[]	getRuleTypes() Gets the availble action types.
RuleType[]	getRuleTypesImpl()
void	removeActions(Reference reference, Action[] webServiceActions) Removes saved actions.
void	removeRules(Reference reference, Rule[] webServiceRules) Remove saved rules.
void	removeRulesImpl(Reference reference, Rule[] webServiceRules)
Action[]	saveActions(Reference reference, Action[] webServiceActions) Save actions against a given reference.
Rule[]	saveRules(Reference reference, Rule[] webServiceRules) Save rules.
void	setActionService(ActionService actionService) Set the action service
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) Set the dictionary service
void	setRuleService(RuleService ruleService) Set the rule service
void	setTransactionService(TransactionServiceImpl transactionService) Sets the transaction service

Methods inherited from class org.alfresco.repo.webservice.AbstractWebService

setContentService, setNamespaceService, setNodeService, setQuerySessionCache, setSearchService, setServiceRegistry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionWebService

public ActionWebService()

Method Detail

setActionService

public void setActionService(ActionService actionService)

Set the action service

Parameters:

actionService - the action service

setRuleService

public void setRuleService(RuleService ruleService)

Set the rule service

Parameters:

ruleService - the rule service

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Set the dictionary service

Overrides:

setDictionaryService in class AbstractWebService

Parameters:

dictionaryService - the dictionary service

setTransactionService

public void setTransactionService(TransactionServiceImpl transactionService)

Sets the transaction service

Parameters:

transactionService - the transaction service

getConditionDefinitions

public ActionItemDefinition[] getConditionDefinitions()
                                               throws RemoteException,
                                                      ActionFault

Description copied from interface: ActionServiceSoapPort

Gets the available condition definitions.

Specified by:

getConditionDefinitions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getConditionDefinitions()

getActionDefinitions

public ActionItemDefinition[] getActionDefinitions()
                                            throws RemoteException,
                                                   ActionFault

Description copied from interface: ActionServiceSoapPort

Gets the available action definitions.

Specified by:

getActionDefinitions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getActionDefinitions()

getActionItemDefinition

public ActionItemDefinition getActionItemDefinition(String name,
                                           ActionItemDefinitionType definitionType)
                                             throws RemoteException,
                                                    ActionFault

Description copied from interface: ActionServiceSoapPort

Get a named action item definition.

Specified by:

getActionItemDefinition in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getActionItemDefinition(java.lang.String, org.alfresco.repo.webservice.action.ActionItemDefinitionType)

getActionItemDefinitionImpl

public ActionItemDefinition getActionItemDefinitionImpl(String name,
                                               ActionItemDefinitionType definitionType)
                                                 throws RemoteException,
                                                        ActionFault

Parameters:

name -

definitionType -

Returns:

Throws:

RemoteException

ActionFault

getRuleTypes

public RuleType[] getRuleTypes()
                        throws RemoteException,
                               ActionFault

Description copied from interface: ActionServiceSoapPort

Gets the availble action types.

Specified by:

getRuleTypes in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getRuleTypes()

getRuleTypesImpl

public RuleType[] getRuleTypesImpl()
                            throws RemoteException,
                                   ActionFault

Throws:

RemoteException

ActionFault

getRuleType

public RuleType getRuleType(String name)
                     throws RemoteException,
                            ActionFault

Description copied from interface: ActionServiceSoapPort

Get a named rule type.

Specified by:

getRuleType in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getRuleType(java.lang.String)

getRuleTypeImpl

public RuleType getRuleTypeImpl(String name)
                         throws RemoteException,
                                ActionFault

Throws:

RemoteException

ActionFault

getActions

public Action[] getActions(Reference reference,
                  ActionFilter filter)
                    throws RemoteException,
                           ActionFault

Description copied from interface: ActionServiceSoapPort

Gets the actions saved against a reference.

Specified by:

getActions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

org.alfresco.repo.webservice.action.ActionServiceSoapPort#getActions(org.alfresco.repo.webservice.types.Reference, java.lang.String[])

saveActions

public Action[] saveActions(Reference reference,
                   Action[] webServiceActions)
                     throws RemoteException,
                            ActionFault

Description copied from interface: ActionServiceSoapPort

Save actions against a given reference.

Specified by:

saveActions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.saveActions(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.action.Action[])

removeActions

public void removeActions(Reference reference,
                 Action[] webServiceActions)
                   throws RemoteException,
                          ActionFault

Description copied from interface: ActionServiceSoapPort

Removes saved actions.

Specified by:

removeActions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.removeActions(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.action.Action[])

executeActions

public ActionExecutionResult[] executeActions(Predicate predicate,
                                     Action[] webServiceActions)
                                       throws RemoteException,
                                              ActionFault

Description copied from interface: ActionServiceSoapPort

Executes actions.

Specified by:

executeActions in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.executeActions(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.action.Action[])

executeActionsImpl

public ActionExecutionResult[] executeActionsImpl(Predicate predicate,
                                         Action[] webServiceActions)
                                           throws RemoteException,
                                                  ActionFault

Execute actions implementation

Parameters:

predicate -

webServiceActions -

Returns:

Throws:

RemoteException

ActionFault

getRules

public Rule[] getRules(Reference reference,
              RuleFilter ruleFilter)
                throws RemoteException,
                       ActionFault

Description copied from interface: ActionServiceSoapPort

Gets the rules for a reference.

Specified by:

getRules in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.getRules(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.action.RuleFilter)

saveRules

public Rule[] saveRules(Reference reference,
               Rule[] webServiceRules)
                 throws RemoteException,
                        ActionFault

Description copied from interface: ActionServiceSoapPort

Save rules.

Specified by:

saveRules in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.saveRules(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.action.Rule[])

removeRules

public void removeRules(Reference reference,
               Rule[] webServiceRules)
                 throws RemoteException,
                        ActionFault

Description copied from interface: ActionServiceSoapPort

Remove saved rules.

Specified by:

removeRules in interface ActionServiceSoapPort

Throws:

RemoteException

ActionFault

See Also:

ActionServiceSoapPort.removeRules(org.alfresco.repo.webservice.types.Reference, org.alfresco.repo.webservice.action.Rule[])

removeRulesImpl

public void removeRulesImpl(Reference reference,
                   Rule[] webServiceRules)
                     throws RemoteException,
                            ActionFault

Parameters:

reference -

webServiceRules -

Throws:

RemoteException

ActionFault