Package org.ametys.odf.workflow.copy

Class AbstractCreateODFContentByCopyFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.cms.workflow.copy.CreateContentByCopyFunction

org.ametys.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCreateProgramItemByCopyFunction, CreateCoursePartByCopyFunction, CreateOrgUnitByCopyFunction, CreatePersonByCopyFunction

public abstract class AbstractCreateODFContentByCopyFunction
extends CreateContentByCopyFunction

OSWorkflow function to create a odf content by copy of another

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 ODFHelper	_odfHelper	ODF helper
static final String	PARENT_KEY	Key for the parent of the target content

Fields inherited from class org.ametys.cms.workflow.copy.CreateContentByCopyFunction

_copyContentComponent, _cTypesHelper, _i18nUtils, BASE_CONTENT_ID, BASE_CONTENT_KEY, COPY_FALLBACK_VIEW_NAME, COPY_MAP_KEY, COPY_REPORT_KEY, COPY_VIEW_NAME

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

_contentTypeEP, _contentTypeHelper, _observationManager, _resolver, CONTENT_LANGUAGE_KEY, CONTENT_MIXINS_KEY, CONTENT_NAME_KEY, CONTENT_TITLE_KEY, CONTENT_TITLE_VARIANTS_KEY, CONTENT_TYPES_KEY, INITIAL_VALUE_SUPPLIER, PARENT_CONTEXT_VALUE, ROOT_CONTENT_PATH_KEY

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
AbstractCreateODFContentByCopyFunction()

Method Summary

Modifier and Type	Method	Description
protected abstract SynchronizableValue	_buildParentSynchronizableValue(Content parent)	Get the parent attribute synchronizable value.
protected ModifiableWorkflowAwareContent	_createContent(Map transientVars, Map args, String desiredContentName, ModifiableTraversableAmetysObject contentsNode)	Create the content object.
protected abstract String	_getContentNamePrefix()	Get the prefix for content name
protected AmetysObjectCollection<?,ModifiableWorkflowAwareContent>	_getContentRoot(Map transientVars)	Retrieve the content root.
protected Content	_getParent(Map transientVars)	Get the parent content if exists.
protected abstract String	_getParentAttributeName(Content parent)	Get the parent attribute name.
protected abstract boolean	_isCompatibleParent(Content parent)	Check if the parent is compatible
protected void	processValues(Map transientVars, ModifiableContent targetContent, Map<String,Object> values)	Called after creation and before execution of the EditContentFunction to allow subclasses to add/remove/modify the values.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.workflow.copy.CreateContentByCopyFunction

execute, getAdditionalCopyMap, getBaseContentForCopy, getLabel

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

_eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _getObjectType, _initWorkflow, _isMultilingual, _notifyContentAdded, _populateAdditionalData, _populateContent, _setTitle, getFunctionExecType, getSystemUser

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

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

getArguments, getFullLabel, getVisibilities

Field Details

PARENT_KEY

public static final String PARENT_KEY

Key for the parent of the target content

_odfHelper

protected ODFHelper _odfHelper

ODF helper

Constructor Details

AbstractCreateODFContentByCopyFunction

public AbstractCreateODFContentByCopyFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentByCopyFunction

Throws:

ServiceException

_getContentRoot

protected AmetysObjectCollection<?,ModifiableWorkflowAwareContent> _getContentRoot(Map transientVars)
                                                                            throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentFunction

Retrieve the content root.

Overrides:

_getContentRoot in class CreateContentFunction

Parameters:

transientVars - the workflow parameters.

Returns:

the content root node.

Throws:

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

_createContent

protected ModifiableWorkflowAwareContent _createContent(Map transientVars,
 Map args,
 String desiredContentName,
 ModifiableTraversableAmetysObject contentsNode)

Description copied from class: CreateContentFunction

Create the content object.

Overrides:

_createContent in class CreateContentFunction

Parameters:

transientVars - the workflow parameters.

args - The workflow function arguments

desiredContentName - the desired content name.

contentsNode - the content root node in the repository.

Returns:

the created Content.

processValues

protected void processValues(Map transientVars,
 ModifiableContent targetContent,
 Map<String,Object> values)
                      throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentByCopyFunction

Called after creation and before execution of the EditContentFunction to allow subclasses to add/remove/modify the values.

Overrides:

processValues in class CreateContentByCopyFunction

Parameters:

transientVars - The workflow transient vars

targetContent - The newly created content

values - the values computed from the copyMap and to be given to the EditContentFunction.

Throws:

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

_getParent

protected Content _getParent(Map transientVars)

Get the parent content if exists.

Parameters:

transientVars - The transient vars

Returns:

the parent content (may be not compatible at this stage)

_isCompatibleParent

protected abstract boolean _isCompatibleParent(Content parent)

Check if the parent is compatible

Parameters:

parent - The parent

Returns:

true if the parent is compatible

_getParentAttributeName

protected abstract String _getParentAttributeName(Content parent)

Get the parent attribute name.

Parameters:

parent - The parent

Returns:

the parent attribute name

_buildParentSynchronizableValue

protected abstract SynchronizableValue _buildParentSynchronizableValue(Content parent)

Get the parent attribute synchronizable value.

Parameters:

parent - The parent

Returns:

a synchronizable value

_getContentNamePrefix

protected abstract String _getContentNamePrefix()

Get the prefix for content name

Returns:

the prefix