Package org.ametys.plugins.contentio.synchronize.workflow

Class EditSynchronizedContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.EditContentFunction

org.ametys.plugins.contentio.synchronize.workflow.EditSynchronizedContentFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction, Initializable, LogEnabled, Serviceable

public class EditSynchronizedContentFunction
extends EditContentFunction

OSWorkflow function to edit (import or synchronize) a synchronized content.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.workflow.EnhancedFunction

EnhancedFunction.FunctionArgument

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_PARAMS_KEY	Constant for storing the import parameters into the transient variables map.
static final int	DEFAULT_INVERT_EDIT_ACTION_ID	Default action id of editing revert relations.
static final int	DEFAULT_SYNCHRO_INVERT_EDIT_ACTION_ID	Default action id of editing invert relations on synchronized contents.
static final String	IMPORT	Import mode parameter.
static final String	INVERT_EDIT_ACTION_ID_KEY	Constant for storing the action id for editing invert relations.
static final String	NOT_SYNCHRONIZED_RELATED_CONTENT_IDS_KEY	Constant for storing the ids of the contents related to the current content but that are not part of the synchronization
static final String	SCC_KEY	Constant for storing the scc into the transient variables map.
static final String	SCC_LOGGER_KEY	Constant for storing the scc logger into the transient variables map.
static final String	SYNCHRO_INVERT_EDIT_ACTION_ID_KEY	Constant for storing the action id for editing invert relations on synchronized contents.

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

_contentDataHelper, _contentTypeExtensionPoint, _contentTypesHelper, _externalizableDataProviderEP, _observationManager, _outgoingReferencesExtractor, _userManager, _workflowHelper, FALLBACK_VIEW_NAME, FORM_ELEMENTS_PREFIX, FORM_RAW_COMMENTS, FORM_RAW_VALUES, GLOBAL_ERROR_KEY, GLOBAL_VALIDATION, INTERNAL_FORM_ELEMENTS_PREFIX, INVERT_EDIT_ACTION_ID, INVERT_RELATION_EDIT_WORKFLOW_ACTION_ID, LOCAL_ONLY, QUIT, SYNCHRONIZATION_RESULT, VALUES_KEY, VIEW, VIEW_ITEMS, VIEW_NAME

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

_contentHelper, CONTENT_KEY, HAS_CHANGED_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	Description
EditSynchronizedContentFunction()

Method Summary

Modifier and Type	Method	Description
protected boolean	_canWriteModelItem(ModelItem modelItem, Content content, Map transientVars)	Returns true if the current model item is writable for this content in the current context.
protected Object	_convertValue(ElementDefinition definition, Object value, Map transientVars)	Converts the given value according to the given definition If the value is multiple, an array is retrieved with each value converted to the right type
protected ContentSynchronizationResult	additionalOperations(ModifiableContent content, Map transientVars)	Allow to do some other modifications on the given content before saving changes
protected void	extractOutgoingReferences(ModifiableContent content, SynchronizationResult synchronizationResult)	Analyze the content to extract outgoing references and store them
protected Map<String,Object>	getAdditionalParameters(Map transientVars)	Retrieve the synchronization additional parameters
protected int	getInvertEditActionId(Map transientVars, Content referencedContent)	Get the identifier of the invert edit action
protected Logger	getLogger(Map transientVars)	Retrieve the scc logger
protected Optional<SynchronizableContentsCollection>	getSynchronizableContentsCollection(Map transientVars)	Retrieve the scc associated with the workflow.
protected ContentSynchronizationContext	getSynchronizationContext(Map transientVars)	Retrieves the synchronization context
protected ExternalizableDataProvider.ExternalizableDataStatus	getValueExternalizableDataStatus(Content content, ModelItem definition, Map transientVars)	Get the status of the value to modify
protected void	globalValidate(View view, Content content, Map<String,Object> values, AllErrors allErrors)	Performs a global validation of the Content, based on declared ContentValidators.
protected boolean	isImportMode(Map transientVars)	Determine if the content is being imported or synchronized
protected void	notifyContentModified(Content content, Map transientVars, SynchronizationResult synchronizationResult)	Notify observers that the content has been modified
protected void	notifyContentModifying(Content content, Map<String,Object> values, Map transientVars)	Notify observers that the content is being modified
protected void	updateCommonMetadata(ModifiableContent content, UserIdentity user, SynchronizationResult synchronizationResult)	Updates common metadata (last contributor, last modification date, ...).
protected void	validateValues(View view, ModifiableContent content, Map<String,Object> values, AllErrors allErrors, Map transientVars)	Validates all input values.

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

execute, getArguments, getDescription, getValues, getView, initialize, invertRelationEnabled, prepareSynchronize, synchronize, triggerInvertWorkflowAction, validateRepeaterValue, validateValue

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

getContent, service

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 Details

SYNCHRO_INVERT_EDIT_ACTION_ID_KEY

public static final String SYNCHRO_INVERT_EDIT_ACTION_ID_KEY

Constant for storing the action id for editing invert relations on synchronized contents.

INVERT_EDIT_ACTION_ID_KEY

public static final String INVERT_EDIT_ACTION_ID_KEY

Constant for storing the action id for editing invert relations.

NOT_SYNCHRONIZED_RELATED_CONTENT_IDS_KEY

public static final String NOT_SYNCHRONIZED_RELATED_CONTENT_IDS_KEY

Constant for storing the ids of the contents related to the current content but that are not part of the synchronization

SCC_KEY

public static final String SCC_KEY

Constant for storing the scc into the transient variables map.

SCC_LOGGER_KEY

public static final String SCC_LOGGER_KEY

Constant for storing the scc logger into the transient variables map.

ADDITIONAL_PARAMS_KEY

public static final String ADDITIONAL_PARAMS_KEY

Constant for storing the import parameters into the transient variables map.

DEFAULT_SYNCHRO_INVERT_EDIT_ACTION_ID

public static final int DEFAULT_SYNCHRO_INVERT_EDIT_ACTION_ID

Default action id of editing invert relations on synchronized contents.

See Also:

• Constant Field Values

DEFAULT_INVERT_EDIT_ACTION_ID

public static final int DEFAULT_INVERT_EDIT_ACTION_ID

Default action id of editing revert relations.

See Also:

• Constant Field Values

IMPORT

public static final String IMPORT

Import mode parameter. If the parameter is present and set to true, the content is considered as imported. Otherwise, it is considered as synchronized.

See Also:

• Constant Field Values

Constructor Details

EditSynchronizedContentFunction

public EditSynchronizedContentFunction()

Method Details

getValueExternalizableDataStatus

protected ExternalizableDataProvider.ExternalizableDataStatus getValueExternalizableDataStatus(Content content,
 ModelItem definition,
 Map transientVars)

Description copied from class: EditContentFunction

Get the status of the value to modify

Overrides:

getValueExternalizableDataStatus in class EditContentFunction

Parameters:

content - the content

definition - the definition of the value

transientVars - the parameters from the call

Returns:

the status of the value

getSynchronizationContext

protected ContentSynchronizationContext getSynchronizationContext(Map transientVars)

Description copied from class: EditContentFunction

Retrieves the synchronization context

Overrides:

getSynchronizationContext in class EditContentFunction

Parameters:

transientVars - the parameters from the call

Returns:

the synchronization context

_convertValue

protected Object _convertValue(ElementDefinition definition,
 Object value,
 Map transientVars)

Description copied from class: EditContentFunction

Converts the given value according to the given definition If the value is multiple, an array is retrieved with each value converted to the right type

Overrides:

_convertValue in class EditContentFunction

Parameters:

definition - the definition

value - the value to convert

transientVars - the parameters from the call.

Returns:

the converted value

validateValues

protected void validateValues(View view,
 ModifiableContent content,
 Map<String,Object> values,
 AllErrors allErrors,
 Map transientVars)
                       throws com.opensymphony.workflow.WorkflowException

Description copied from class: EditContentFunction

Validates all input values.

Overrides:

validateValues in class EditContentFunction

Parameters:

view - the model's view corresponding to the values

content - the current content

values - the actual input values

allErrors - object to be populated with validation errors

transientVars - the parameters from the call

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

globalValidate

protected void globalValidate(View view,
 Content content,
 Map<String,Object> values,
 AllErrors allErrors)

Description copied from class: EditContentFunction

Performs a global validation of the Content, based on declared ContentValidators.

Overrides:

globalValidate in class EditContentFunction

Parameters:

view - the current View

content - the current Content.

values - the values being set

allErrors - object to be populated with validation errors

additionalOperations

protected ContentSynchronizationResult additionalOperations(ModifiableContent content,
 Map transientVars)
                                                     throws com.opensymphony.workflow.WorkflowException

Description copied from class: EditContentFunction

Allow to do some other modifications on the given content before saving changes

Overrides:

additionalOperations in class EditContentFunction

Parameters:

content - the content

transientVars - the parameters from the call

Returns:

The synchronization result od additional operations

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

isImportMode

protected boolean isImportMode(Map transientVars)
                        throws com.opensymphony.workflow.WorkflowException

Determine if the content is being imported or synchronized

Parameters:

transientVars - the parameters from the call.

Returns:

true if the content is being imported, false otherwise

Throws:

com.opensymphony.workflow.WorkflowException - if the object model or the request is not present

getSynchronizableContentsCollection

protected Optional<SynchronizableContentsCollection> getSynchronizableContentsCollection(Map transientVars)

Retrieve the scc associated with the workflow.

Parameters:

transientVars - the parameters from the call.

Returns:

the scc.

getLogger

protected Logger getLogger(Map transientVars)

Retrieve the scc logger

Parameters:

transientVars - the parameters from the call.

Returns:

the scc logger

getAdditionalParameters

protected Map<String,Object> getAdditionalParameters(Map transientVars)

Retrieve the synchronization additional parameters

Parameters:

transientVars - the parameters from the call.

Returns:

the synchronization additional parameters

getInvertEditActionId

protected int getInvertEditActionId(Map transientVars,
 Content referencedContent)

Description copied from class: EditContentFunction

Get the identifier of the invert edit action

Overrides:

getInvertEditActionId in class EditContentFunction

Parameters:

transientVars - The workflow vars

referencedContent - the content concerned by the invert relation

Returns:

the identifier of the invert edit action

notifyContentModifying

protected void notifyContentModifying(Content content,
 Map<String,Object> values,
 Map transientVars)
                               throws com.opensymphony.workflow.WorkflowException

Description copied from class: EditContentFunction

Notify observers that the content is being modified

Overrides:

notifyContentModifying in class EditContentFunction

Parameters:

content - The content being modified

values - the new values being set to the content

transientVars - The workflow vars

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

updateCommonMetadata

protected void updateCommonMetadata(ModifiableContent content,
 UserIdentity user,
 SynchronizationResult synchronizationResult)
                             throws com.opensymphony.workflow.WorkflowException

Description copied from class: EditContentFunction

Updates common metadata (last contributor, last modification date, ...).

Overrides:

updateCommonMetadata in class EditContentFunction

Parameters:

content - the content.

user - the user.

synchronizationResult - The result of the content values synchronization

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs.

extractOutgoingReferences

protected void extractOutgoingReferences(ModifiableContent content,
 SynchronizationResult synchronizationResult)

Description copied from class: EditContentFunction

Analyze the content to extract outgoing references and store them

Overrides:

extractOutgoingReferences in class EditContentFunction

Parameters:

content - The content to analyze

synchronizationResult - The result of the content values synchronization

notifyContentModified

protected void notifyContentModified(Content content,
 Map transientVars,
 SynchronizationResult synchronizationResult)
                              throws com.opensymphony.workflow.WorkflowException

Description copied from class: EditContentFunction

Notify observers that the content has been modified

Overrides:

notifyContentModified in class EditContentFunction

Parameters:

content - The content modified

transientVars - The workflow vars

synchronizationResult - The result of the content values synchronization

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

_canWriteModelItem

protected boolean _canWriteModelItem(ModelItem modelItem,
 Content content,
 Map transientVars)

Description copied from class: EditContentFunction

Returns true if the current model item is writable for this content in the current context.

Overrides:

_canWriteModelItem in class EditContentFunction

Parameters:

modelItem - The model item to check

content - The content

transientVars - The parameters from the call

Returns:

true if the current model item is writable