Package org.ametys.cms.workflow

Class EditContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.EditContentFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

EditSynchronizedContentFunction

public class EditContentFunction
extends AbstractContentWorkflowComponent
implements EnhancedFunction, Initializable

OSWorkflow function to edit a content.

Values are set either programmatically, or parsed from form submission by their ElementTypes according to the Content model.

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.RESULT_MAP_KEY.<MetadataPath> - Errors Each error during edition will be set here. Key will be the metadata path (with '.' separator). Value will be the error message.
- AbstractContentWorkflowComponent.CONTENT_KEY - WorkflowAwareContent The content that will be edited. Should have the lock token.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY - Map<String, Object> Contains the following parameters:
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.QUIT - boolean True to specify edition mode will be quit, this imply to unlock the content.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.VIEW_PARAM The name of the view to use and to check attributes. If missing a view will be created from values.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.FALLBACK_VIEW_PARAM The name of the view to use if the initial view does not exist on the Content's model.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.VALUES_KEY - Map<String, Object> The typed values. If present, raw values must not be present.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.FORM_RAW_VALUES - Map<String, Object> The values of the submitted form. If present, types values must not be present.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.FORM_RAW_VALUES.<MetadataPath> Object Key is the path of the metadata ('.' separated) prefixed by FORM_ELEMENTS_PREFIX. Value is a depending on the type of metadata. Sometimes types require additional information. In that case : Key is a metadata path ('.' separated) prefixed by INTERNAL_FORM_ELEMENTS_PREFIX and suffixed by '.' + an additional information name.
- AbstractWorkflowComponent.CONTEXT_PARAMETERS_KEY.FORM_RAW_COMMENTS - Map<String, List<Map<String, String>>> The comments of the metadata of the submitted form :
- AbstractContentWorkflowComponent.RESULT_MAP_KEY.<MetadataPath> - List<Map<String, String>> Key is the path of the metadata ('.' separated) prefixed by FORM_ELEMENTS_PREFIX. Value is the list of comments.
- AbstractContentWorkflowComponent.RESULT_MAP_KEY.<MetadataPath>.<X> - <Map<String, String> A comment with the following parameters
- AbstractContentWorkflowComponent.RESULT_MAP_KEY.<MetadataPath>.<X>.author String The login of the author of the comment
- AbstractContentWorkflowComponent.RESULT_MAP_KEY.<MetadataPath>.<X>.text String The text of the comment
- AbstractContentWorkflowComponent.RESULT_MAP_KEY.<MetadataPath>.<X>.date String The date of the comment using the ISODateTimeFormat (See DateUtils.parse)
Where <MetadataPath> is the path of a metadata (using a '.' separator). In some cases it is prefixed by FORM_ELEMENTS_PREFIX. A metadata path with in a repeater include the number of the repeated instance (1 based).
Where <X> Is an element of the parent list.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

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

EnhancedFunction.FunctionType

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentDataHelper	_contentDataHelper	Helper for collecting content references
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	Content type extension point.
protected ContentTypesHelper	_contentTypesHelper	Helper for content types
protected DisableConditionsEvaluator<ModelAwareDataHolder>	_disableConditionsEvaluator	The DisableConditions evaluator
protected ExternalizableDataProviderExtensionPoint	_externalizableDataProviderEP	Provider for externalizable data
protected I18nUtils	_i18nUtils	The i18n utils
protected ObservationManager	_observationManager	Observation manager available to subclasses.
protected OutgoingReferencesExtractor	_outgoingReferencesExtractor	The outgoing references extractor
protected UserManager	_userManager	The user manager
protected ContentWorkflowHelper	_workflowHelper	The content workflow helper.
static final String	FALLBACK_VIEW_NAME	Fallback view name parameter.
static final String	FORM_ELEMENTS_PREFIX	Prefix for HTML form elements.
static final String	FORM_RAW_COMMENTS	Request parameter key for the field comments.
static final String	FORM_RAW_VALUES	Request parameter key for the field values.
static final String	FORM_RAW_VERSION	Request parameter key for the field with version.
static final String	GLOBAL_VALIDATION	Set to false to deactivate global validation, default value is true
static final String	GLOBAL_VALIDATION_RESULT_KEY	The key for global errors
static final String	IGNORE_WARNINGS	Set to true to ignore warnings and continue edition, default value is true
static final String	INTERNAL_FORM_ELEMENTS_PREFIX	Prefix for internal HTML form elements.
static final int	INVERT_EDIT_ACTION_ID	Default action id of editing revert relations.
static final String	INVERT_RELATION_EDIT_WORKFLOW_ACTION_ID	Constant for storing the action id for editing revert relations.
static final String	KEY_NOTIFY_ARGUMENTS	Key for notify argument
static final String	LOCAL_ONLY	Local only parameter.
static final String	QUIT	Quit edition mode parameter.
static final String	RESULT_STATE_KEY	Constant for storing the result's state (ok / warnings / errors) into the transient variables map.
static final String	RESULT_STATE_OK	Constant for the OK result's state
static final String	SYNCHRONIZATION_RESULT	Optional previous synchronization result
static final String	VALIDATION_RESULTS_FIELD_LABEL_KEY	Constant for storing the field's label
static final String	VALIDATION_RESULTS_FIELD_PATH_KEY	Constant for storing the field's path
static final String	VALIDATION_RESULTS_FIELD_RESULT_KEY	Constant for storing the field validation's result
static final String	VALUES_KEY	Inputs key for typed values.
static final String	VIEW	View parameter.
static final String	VIEW_ITEMS	View items parameter.
static final String	VIEW_NAME	View name parameter.

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_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
EditContentFunction()

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 Map<String,Object>	_convertValues(ModifiableContent content, View view, Map<String,Object> values, Map transientVars)	Converts the given values according to the definitions in the given ViewItemAccessor
protected ContentSynchronizationResult	additionalOperations(ModifiableContent content, Map transientVars)	Allow to do some other modifications on the given content before saving changes
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
protected void	extractOutgoingReferences(ModifiableContent content, SynchronizationResult synchronizationResult)	Analyze the content to extract outgoing references and store them
EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
protected int	getInvertEditActionId(Map transientVars, Content referencedContent)	Get the identifier of the invert edit action
I18nizableText	getLabel()	Get the label for this function
protected ContentSynchronizationContext	getSynchronizationContext(Map transientVars)	Retrieves the synchronization context
protected Map<String,Object>	getValues(View view, ModifiableContent content, Map<String,Object> typedValues, Map<String,Object> rawValues, Map<String,List<Map<String,String>>> rawComments, boolean localOnly, Map transientVars)	Computes the actual typed values from the input.
protected View	getView(Map<String,Object> parameters, Map<String,Object> values, Map<String,Object> rawValues, Content content, Map transientVars)	Get the view for the content
protected ValidationResult	globalValidate(View view, Content content, Map<String,Object> values)	Performs a global validation of the Content, based on declared ContentValidators.
void	initialize()
protected boolean	invertRelationEnabled()	Template method to indicates if invert relation should be taken into account during the whole edition.
protected void	notifyContentModifying(Content content, Map<String,Object> values, Map transientVars)	Notify observers that the content is being modified
protected void	prepareOrNotifyContentModified(Content content, Map transientVars, Map args, SynchronizationResult synchronizationResult)	Prepare or notify observers that the content has been modified
protected Collection<ReferencedContents>	prepareSynchronize(ModifiableContent content, View view, Map<String,Object> values, UserIdentity user, ValidationResults validationResults, Map transientVars)	Prepares the write process by checking remote contents concerned by invert relations.
protected Map<String,Object>	processDisableConditions(View view, ModifiableContent content, Map<String,Object> values, Map<String,Object> contextualParameters)	Processes disable conditions on given values
protected Optional<Object>	processDisableConditionsOnComposite(ModelViewItemGroup group, CompositeDefinition definition, String prefix, Optional<String> oldPrefix, ModifiableContent content, Map<String,Object> currentValues, Map<String,Object> allValues, Map<String,Object> contextualParameters)	Processes disable conditions on given composite
protected Optional<Object>	processDisableConditionsOnElement(ElementDefinition definition, String prefix, Optional<String> oldPrefix, ModifiableContent content, Map<String,Object> currentValues, Map<String,Object> allValues, Map<String,Object> contextualParameters)	Processes disable conditions on given element
protected Optional<Object>	processDisableConditionsOnRepeater(ModelViewItemGroup group, RepeaterDefinition definition, String prefix, Optional<String> oldPrefix, ModifiableContent content, Map<String,Object> currentValues, Map<String,Object> allValues, Map<String,Object> contextualParameters)	Processes disable conditions on given repeater
protected SynchronizationResult	synchronize(ModifiableContent content, View view, Map<String,Object> values, Collection<ReferencedContents> referencedContents, Map transientVars)	Synchronize the values of the given content
protected void	triggerInvertWorkflowAction(Content content, int actionId)	Trigger a 'edit content' workflow action (if the content is workflow-aware).
protected void	updateCommonMetadata(ModifiableContent content, UserIdentity user, SynchronizationResult synchronizationResult)	Updates common metadata (last contributor, last modification date, ...).
protected ValidationResults	validateRepeaterValue(ModelViewItemGroup viewItem, RepeaterDefinition definition, String dataPath, Optional<String> oldDataPath, ModifiableContent content, Object value, Map transientVars)	Validate repeater values.
protected ValidationResult	validateValue(ElementDefinition definition, String dataPath, Optional<String> oldDataPath, ModifiableContent content, Object value, Map transientVars)	Validate an attribute value.
protected ValidationResults	validateValues(View view, ModifiableContent content, Map<String,Object> values, Map transientVars)	Validates all input values.

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getArguments, getFullLabel, getVisibilities

Field Details

INVERT_RELATION_EDIT_WORKFLOW_ACTION_ID

public static final String INVERT_RELATION_EDIT_WORKFLOW_ACTION_ID

Constant for storing the action id for editing revert relations.

FORM_ELEMENTS_PREFIX

public static final String FORM_ELEMENTS_PREFIX

Prefix for HTML form elements.

See Also:

• Constant Field Values

GLOBAL_VALIDATION_RESULT_KEY

public static final String GLOBAL_VALIDATION_RESULT_KEY

The key for global errors

See Also:

• Constant Field Values

INTERNAL_FORM_ELEMENTS_PREFIX

public static final String INTERNAL_FORM_ELEMENTS_PREFIX

Prefix for internal HTML form elements.

See Also:

• Constant Field Values

VALUES_KEY

public static final String VALUES_KEY

Inputs key for typed values.

See Also:

• Constant Field Values

FORM_RAW_VALUES

public static final String FORM_RAW_VALUES

Request parameter key for the field values.

See Also:

• Constant Field Values

FORM_RAW_COMMENTS

public static final String FORM_RAW_COMMENTS

Request parameter key for the field comments.

See Also:

• Constant Field Values

FORM_RAW_VERSION

public static final String FORM_RAW_VERSION

Request parameter key for the field with version.

See Also:

• Constant Field Values

VIEW

public static final String VIEW

View parameter.

See Also:

• Constant Field Values

VIEW_ITEMS

public static final String VIEW_ITEMS

View items parameter.

See Also:

• Constant Field Values

VIEW_NAME

public static final String VIEW_NAME

View name parameter.

See Also:

• Constant Field Values

FALLBACK_VIEW_NAME

public static final String FALLBACK_VIEW_NAME

Fallback view name parameter.

See Also:

• Constant Field Values

GLOBAL_VALIDATION

public static final String GLOBAL_VALIDATION

Set to false to deactivate global validation, default value is true

See Also:

• Constant Field Values

IGNORE_WARNINGS

public static final String IGNORE_WARNINGS

Set to true to ignore warnings and continue edition, default value is true

See Also:

• Constant Field Values

QUIT

public static final String QUIT

Quit edition mode parameter.

See Also:

• Constant Field Values

LOCAL_ONLY

public static final String LOCAL_ONLY

Local only parameter.

See Also:

• Constant Field Values

SYNCHRONIZATION_RESULT

public static final String SYNCHRONIZATION_RESULT

Optional previous synchronization result

See Also:

• Constant Field Values

INVERT_EDIT_ACTION_ID

public static final int INVERT_EDIT_ACTION_ID

Default action id of editing revert relations.

See Also:

• Constant Field Values

KEY_NOTIFY_ARGUMENTS

public static final String KEY_NOTIFY_ARGUMENTS

Key for notify argument

See Also:

• Constant Field Values

RESULT_STATE_KEY

public static final String RESULT_STATE_KEY

Constant for storing the result's state (ok / warnings / errors) into the transient variables map.

See Also:

• Constant Field Values

RESULT_STATE_OK

public static final String RESULT_STATE_OK

Constant for the OK result's state

See Also:

• Constant Field Values

VALIDATION_RESULTS_FIELD_RESULT_KEY

public static final String VALIDATION_RESULTS_FIELD_RESULT_KEY

Constant for storing the field validation's result

See Also:

• Constant Field Values

VALIDATION_RESULTS_FIELD_LABEL_KEY

public static final String VALIDATION_RESULTS_FIELD_LABEL_KEY

Constant for storing the field's label

See Also:

• Constant Field Values

VALIDATION_RESULTS_FIELD_PATH_KEY

public static final String VALIDATION_RESULTS_FIELD_PATH_KEY

Constant for storing the field's path

See Also:

• Constant Field Values

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

Content type extension point.

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

Helper for content types

_observationManager

protected ObservationManager _observationManager

Observation manager available to subclasses.

_workflowHelper

protected ContentWorkflowHelper _workflowHelper

The content workflow helper.

_outgoingReferencesExtractor

protected OutgoingReferencesExtractor _outgoingReferencesExtractor

The outgoing references extractor

_userManager

protected UserManager _userManager

The user manager

_externalizableDataProviderEP

protected ExternalizableDataProviderExtensionPoint _externalizableDataProviderEP

Provider for externalizable data

_contentDataHelper

protected ContentDataHelper _contentDataHelper

Helper for collecting content references

_disableConditionsEvaluator

protected DisableConditionsEvaluator<ModelAwareDataHolder> _disableConditionsEvaluator

The DisableConditions evaluator

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

Constructor Details

EditContentFunction

public EditContentFunction()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

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

getInvertEditActionId

protected int getInvertEditActionId(Map transientVars,
 Content referencedContent)

Get the identifier of the invert edit action

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

Notify observers that the content is being modified

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

prepareOrNotifyContentModified

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

Prepare or notify observers that the content has been modified

Parameters:

content - The content modified

transientVars - The workflow vars

args - the workflow args

synchronizationResult - The result of the content values synchronization

Throws:

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

getView

protected View getView(Map<String,Object> parameters,
 Map<String,Object> values,
 Map<String,Object> rawValues,
 Content content,
 Map transientVars)
                throws com.opensymphony.workflow.WorkflowException

Get the view for the content

Parameters:

parameters - The parameters

values - Typed values from inputs

rawValues - The raw values of the form

content - The content

transientVars - the parameters from the call

Returns:

The view asked in the request or a built-in view

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred while getting the view

getValues

protected Map<String,Object> getValues(View view,
 ModifiableContent content,
 Map<String,Object> typedValues,
 Map<String,Object> rawValues,
 Map<String,List<Map<String,String>>> rawComments,
 boolean localOnly,
 Map transientVars)
                                throws com.opensymphony.workflow.WorkflowException

Computes the actual typed values from the input.

Parameters:

view - the current View

content - the current Content

typedValues - typed values, if any

rawValues - raw values from form, if any

rawComments - the form comments, if any

localOnly - if the form values are local only or may include external values

transientVars - the parameters from the call.

Returns:

the actual values to be set

Throws:

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

_convertValues

protected Map<String,Object> _convertValues(ModifiableContent content,
 View view,
 Map<String,Object> values,
 Map transientVars)

Converts the given values according to the definitions in the given ViewItemAccessor

Parameters:

content - the current content

view - the current view

values - the values to convert

transientVars - the parameters from the call

Returns:

the converted values

processDisableConditions

protected Map<String,Object> processDisableConditions(View view,
 ModifiableContent content,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)

Processes disable conditions on given values

Parameters:

view - the current view

content - the current content

values - the values to process

contextualParameters - the contextual parameters

Returns:

the values with UntouchedValues for instead of disabled ones

processDisableConditionsOnElement

protected Optional<Object> processDisableConditionsOnElement(ElementDefinition definition,
 String prefix,
 Optional<String> oldPrefix,
 ModifiableContent content,
 Map<String,Object> currentValues,
 Map<String,Object> allValues,
 Map<String,Object> contextualParameters)

Processes disable conditions on given element

Parameters:

definition - the element's definition

prefix - the prefix for computing current data path

oldPrefix - the prefix for computing old data path

content - the current content

currentValues - the values to process

allValues - all values of the current edition

contextualParameters - the contextual parameters

Returns:

the values of the element, or UntouchedValue if disabled

processDisableConditionsOnComposite

protected Optional<Object> processDisableConditionsOnComposite(ModelViewItemGroup group,
 CompositeDefinition definition,
 String prefix,
 Optional<String> oldPrefix,
 ModifiableContent content,
 Map<String,Object> currentValues,
 Map<String,Object> allValues,
 Map<String,Object> contextualParameters)

Processes disable conditions on given composite

Parameters:

group - the composite's view item

definition - the composite's definition

prefix - the prefix for computing current data path

oldPrefix - the prefix for computing old data path

content - the current content

currentValues - the values to process

allValues - all values of the current edition

contextualParameters - the contextual parameters

Returns:

the values of the composite, or UntouchedValue if disabled

processDisableConditionsOnRepeater

protected Optional<Object> processDisableConditionsOnRepeater(ModelViewItemGroup group,
 RepeaterDefinition definition,
 String prefix,
 Optional<String> oldPrefix,
 ModifiableContent content,
 Map<String,Object> currentValues,
 Map<String,Object> allValues,
 Map<String,Object> contextualParameters)

Processes disable conditions on given repeater

Parameters:

group - the repeater's view item

definition - the repeater's definition

prefix - the prefix for computing current data path

oldPrefix - the prefix for computing old data path

content - the current content

currentValues - the values to process

allValues - all values of the current edition

contextualParameters - the contextual parameters

Returns:

the values of the repeater, or UntouchedValue if disabled

validateValues

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

Validates all input values.

Parameters:

view - the model's view corresponding to the values

content - the current content

values - the actual input values

transientVars - the parameters from the call

Returns:

the validation results

Throws:

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

validateValue

protected ValidationResult validateValue(ElementDefinition definition,
 String dataPath,
 Optional<String> oldDataPath,
 ModifiableContent content,
 Object value,
 Map transientVars)

Validate an attribute value.

Parameters:

definition - the attribute definition.

dataPath - the attribute path.

oldDataPath - the old data path, i.e. with the repeater entries previous positions. Used to know the current status for externalizable data

content - the Content being edited.

value - the value.

transientVars - the parameters from the call.

Returns:

the validation result

validateRepeaterValue

protected ValidationResults validateRepeaterValue(ModelViewItemGroup viewItem,
 RepeaterDefinition definition,
 String dataPath,
 Optional<String> oldDataPath,
 ModifiableContent content,
 Object value,
 Map transientVars)

Validate repeater values.

Parameters:

viewItem - the view item referencing the repeater

definition - the repeater definition.

dataPath - the repeater path.

oldDataPath - the old repeater data path, i.e. with the repeater entries previous positions. Used to know the current status for externalizable data

content - the Content being edited.

value - the value.

transientVars - the parameters from the call.

Returns:

the validation results

globalValidate

protected ValidationResult globalValidate(View view,
 Content content,
 Map<String,Object> values)

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

Parameters:

view - the current View

content - the current Content.

values - the values being set

Returns:

the validation results

prepareSynchronize

protected Collection<ReferencedContents> prepareSynchronize(ModifiableContent content,
 View view,
 Map<String,Object> values,
 UserIdentity user,
 ValidationResults validationResults,
 Map transientVars)

Prepares the write process by checking remote contents concerned by invert relations.

Parameters:

content - the current content.

view - the current View.

values - the new values.

user - the current user

validationResults - the collected errors

transientVars - the parameters from the call.

Returns:

the ReferencedContents

synchronize

protected SynchronizationResult synchronize(ModifiableContent content,
 View view,
 Map<String,Object> values,
 Collection<ReferencedContents> referencedContents,
 Map transientVars)
                                     throws com.opensymphony.workflow.WorkflowException

Synchronize the values of the given content

Parameters:

content - the content to synchronize

view - the content's view to use for synchronization

values - the values to synchronize

referencedContents - the contents referenced by invert relations

transientVars - the parameters from the call.

Returns:

The result of the synchronization

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs while triggering the edition workflow action for related contents

getSynchronizationContext

protected ContentSynchronizationContext getSynchronizationContext(Map transientVars)

Retrieves the synchronization context

Parameters:

transientVars - the parameters from the call

Returns:

the synchronization context

additionalOperations

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

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

Parameters:

content - the content

transientVars - the parameters from the call

Returns:

The synchronization result of additional operations

Throws:

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

updateCommonMetadata

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

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

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)

Analyze the content to extract outgoing references and store them

Parameters:

content - The content to analyze

synchronizationResult - The result of the content values synchronization

invertRelationEnabled

protected boolean invertRelationEnabled()

Template method to indicates if invert relation should be taken into account during the whole edition. Override and return false to disabled invert relation management.

Returns:

true if invert relation are enabled

triggerInvertWorkflowAction

protected void triggerInvertWorkflowAction(Content content,
 int actionId)
                                    throws com.opensymphony.workflow.WorkflowException

Trigger a 'edit content' workflow action (if the content is workflow-aware).

Parameters:

content - The content.

actionId - The current 'edit content' action ID.

Throws:

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

_canWriteModelItem

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.

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

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Specified by:

getFunctionExecType in interface EnhancedFunction

Returns:

the type 's code

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Returns:

the label