org.ametys.cms.workflow

Class ExtractOutgoingReferencesFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.ExtractOutgoingReferencesFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, LogEnabled, Serviceable

public class ExtractOutgoingReferencesFunction
extends AbstractContentWorkflowComponent
implements com.opensymphony.workflow.FunctionProvider

OSWorkflow function to extract outgoing references in a content. The required transient variables: - AbstractContentWorkflowComponent.RESULT_MAP_KEY - Map<String, Object> The map containing the results of the function. - AbstractContentWorkflowComponent.RESULT_MAP_KEY.result - String "true" when everything goes fine. Missing in other case. - AbstractContentWorkflowComponent.CONTENT_KEY - WorkflowAwareContent The content that will be edited. Should have the lock token.

Field Summary

Fields

Modifier and Type	Field and Description
protected OutgoingReferencesExtractor	_outgoingReferencesExtractor The outgoing references extractor

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

_contentHelper, CONTENT_KEY

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor and Description
ExtractOutgoingReferencesFunction()

Method Summary

Modifier and Type	Method and Description
protected void	_extractOutgoingReferences(ModifiableContent content) Analyze the content to extract outgoing references and store them
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser

Methods inherited from class java.lang.Object

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

Field Detail

_outgoingReferencesExtractor

protected OutgoingReferencesExtractor _outgoingReferencesExtractor

The outgoing references extractor

Constructor Detail

ExtractOutgoingReferencesFunction

public ExtractOutgoingReferencesFunction()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

execute

public void execute(Map transientVars,
                    Map args,
                    com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

_extractOutgoingReferences

protected void _extractOutgoingReferences(ModifiableContent content)

Analyze the content to extract outgoing references and store them

Parameters:

content - The content to analyze