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
,Initializable
,LogEnabled
,Serviceable
public class EditContentFunction
extends AbstractContentWorkflowComponent
implements com.opensymphony.workflow.FunctionProvider, Initializable
OSWorkflow function to edit a content.
Values are set either programmatically, or parsed from form submission by their
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.
Values are set either programmatically, or parsed from form submission by their
ElementType
s 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.
-
Field Summary
Modifier and TypeFieldDescriptionprotected ContentDataHelper
Helper for collecting content referencesprotected ContentTypeExtensionPoint
Content type extension point.protected ContentTypesHelper
Helper for content typesprotected ExternalizableDataProviderExtensionPoint
Provider for externalizable dataprotected ObservationManager
Observation manager available to subclasses.protected OutgoingReferencesExtractor
The outgoing references extractorprotected UserManager
The user managerprotected ContentWorkflowHelper
The content workflow helper.static final String
Constant for storing the action id for editing revert relations.static final String
Fallback view name parameter.static final String
Prefix for HTML form elements.static final String
Request parameter key for the field comments.static final String
Request parameter key for the field values.static final String
The key for global errorsstatic final String
Prefix for internal HTML form elements.static final int
Default action id of editing revert relations.static final String
Constant for storing the action id for editing revert relations.static final String
Local only parameter.static final String
Quit edition mode parameter.static final String
Inputs key for typed values.static final String
View parameter.static final String
View items parameter.static final String
View name parameter.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
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
_triggerEditWorkflowAction
(Content content, int actionId) Trigger a 'edit content' workflow action (if the content is workflow-aware).void
protected void
Analyze the content to extract outgoing references and store themprotected int
getInvertEditActionId
(Map transientVars) Get the identifier of the invert edit actiongetValues
(View view, Map<String, Object> typedValues, ModifiableContent content, Map<String, Object> rawValues, Map<String, List<Map<String, String>>> rawComments, boolean localOnly) 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) Get the view for the contentprotected void
Performs a global validation of the Content, based on declaredContentValidator
s.void
protected boolean
Template method to indicates if invert relation should be taken into account during the whole edition.protected void
notifyContentModified
(Content content, Map transientVars) Notify observers that the content has been modifiedprotected void
Notify observers that the content is being modifiedprotected Collection<ReferencedContents>
prepareSynchronize
(ModifiableContent content, View view, Map<String, Object> values, int invertEditActionId, UserIdentity user, AllErrors allErrors) Prepares the write process by checking remote contents concerned by invert relations.protected void
updateCommonMetadata
(ModifiableContent content, UserIdentity user) Updates common metadata (last contributor, last modification date, ...).protected void
validateValue
(ElementDefinition definition, ModifiableContent content, String dataPath, AllErrors allErrors, Object value) Validate an attribute value.protected void
validateValues
(View view, Map<String, Object> values, ModifiableContent content, AllErrors allErrors) 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
-
Field Details
-
INVERT_RELATION_EDIT_WORKFLOW_ACTION_ID
Constant for storing the action id for editing revert relations. -
EDIT_MUTUAL_RELATIONSHIP
Constant for storing the action id for editing revert relations. -
FORM_ELEMENTS_PREFIX
Prefix for HTML form elements.- See Also:
-
GLOBAL_ERROR_KEY
The key for global errors- See Also:
-
INTERNAL_FORM_ELEMENTS_PREFIX
Prefix for internal HTML form elements.- See Also:
-
VALUES_KEY
Inputs key for typed values.- See Also:
-
FORM_RAW_VALUES
Request parameter key for the field values.- See Also:
-
FORM_RAW_COMMENTS
Request parameter key for the field comments.- See Also:
-
VIEW
View parameter.- See Also:
-
VIEW_ITEMS
View items parameter.- See Also:
-
VIEW_NAME
View name parameter.- See Also:
-
FALLBACK_VIEW_NAME
Fallback view name parameter.- See Also:
-
QUIT
Quit edition mode parameter.- See Also:
-
LOCAL_ONLY
Local only parameter.- See Also:
-
INVERT_EDIT_ACTION_ID
Default action id of editing revert relations.- See Also:
-
_contentTypeExtensionPoint
Content type extension point. -
_contentTypesHelper
Helper for content types -
_observationManager
Observation manager available to subclasses. -
_workflowHelper
The content workflow helper. -
_outgoingReferencesExtractor
The outgoing references extractor -
_userManager
The user manager -
_externalizableDataProviderEP
Provider for externalizable data -
_contentDataHelper
Helper for collecting content references
-
-
Constructor Details
-
EditContentFunction
public EditContentFunction()
-
-
Method Details
-
initialize
- Specified by:
initialize
in interfaceInitializable
- 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 interfacecom.opensymphony.workflow.FunctionProvider
- Throws:
com.opensymphony.workflow.WorkflowException
-
getInvertEditActionId
Get the identifier of the invert edit action- Parameters:
transientVars
- The workflow vars- Returns:
- the identifier of the invert edit action
-
notifyContentModifying
protected void notifyContentModifying(Content content, Map<String, Object> values, Map transientVars) throws com.opensymphony.workflow.WorkflowExceptionNotify observers that the content is being modified- Parameters:
content
- The content being modifiedvalues
- the new values being set to the contenttransientVars
- The workflow vars- Throws:
com.opensymphony.workflow.WorkflowException
- If an error occurred
-
notifyContentModified
protected void notifyContentModified(Content content, Map transientVars) throws com.opensymphony.workflow.WorkflowException Notify observers that the content has been modified- Parameters:
content
- The content modifiedtransientVars
- The workflow vars- Throws:
com.opensymphony.workflow.WorkflowException
- If an error occurred
-
getView
protected View getView(Map<String, Object> parameters, Map<String, throws com.opensymphony.workflow.WorkflowExceptionObject> values, Map<String, Object> rawValues, Content content) Get the view for the content- Parameters:
parameters
- The parametersvalues
- Typed values from inputsrawValues
- The raw values of the formcontent
- The content- 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, Map<String, Object> typedValues, ModifiableContent content, Map<String, Object> rawValues, Map<String, List<Map<String, String>>> rawComments, boolean localOnly) Computes the actual typed values from the input.- Parameters:
view
- the currentView
typedValues
- typed values, if anycontent
- the current ContentrawValues
- raw values from form, if anyrawComments
- the form comments, if anylocalOnly
- if the form values are local only or may include external values- Returns:
- the actual values to be set
-
validateValues
protected void validateValues(View view, Map<String, Object> values, ModifiableContent content, AllErrors allErrors) throws com.opensymphony.workflow.WorkflowExceptionValidates all input values.- Parameters:
view
- the model's view corresponding to the valuesvalues
- the actual input valuescontent
- the current contentallErrors
- object to be populated with validation errors- Throws:
com.opensymphony.workflow.WorkflowException
- If an error occurred
-
validateValue
protected void validateValue(ElementDefinition definition, ModifiableContent content, String dataPath, AllErrors allErrors, Object value) Validate an attribute value.- Parameters:
definition
- the attribute definition.content
- the Content being edited.dataPath
- the attribute path.allErrors
- the errors.value
- the value.
-
globalValidate
protected void globalValidate(Content content, Map<String, Object> values, View view, AllErrors allErrors) Performs a global validation of the Content, based on declaredContentValidator
s. -
prepareSynchronize
protected Collection<ReferencedContents> prepareSynchronize(ModifiableContent content, View view, Map<String, Object> values, int invertEditActionId, UserIdentity user, AllErrors allErrors) 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.invertEditActionId
- the action id to checkuser
- the current userallErrors
- the collected errors- Returns:
- the
ReferencedContents
-
extractOutgoingReferences
Analyze the content to extract outgoing references and store them- Parameters:
content
- The content to analyze
-
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
-
updateCommonMetadata
protected void updateCommonMetadata(ModifiableContent content, UserIdentity user) throws com.opensymphony.workflow.WorkflowException Updates common metadata (last contributor, last modification date, ...).- Parameters:
content
- the content.user
- the user.- Throws:
com.opensymphony.workflow.WorkflowException
- if an error occurs.
-
_triggerEditWorkflowAction
protected void _triggerEditWorkflowAction(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.
-