Package org.ametys.odf.workflow.copy

Class CreateOrgUnitByCopyFunction

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

org.ametys.odf.workflow.copy.CreateOrgUnitByCopyFunction

All Implemented Interfaces:

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

public class CreateOrgUnitByCopyFunction
extends AbstractCreateODFContentByCopyFunction

OSWorkflow function to create a course by copy of another

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields inherited from class org.ametys.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

_odfHelper, PARENT_KEY

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_CONTENT_ID_KEY, PARENT_CONTENT_METADATA_PATH_KEY, PARENT_CONTEXT_VALUE

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

Method Summary

Modifier and Type	Method	Description
protected SynchronizableValue	_buildParentSynchronizableValue(Content parent)	Get the parent attribute synchronizable value.
protected String	_getContentNamePrefix()	Get the prefix for content name
protected String	_getObjectType(Map transientVars, Map args)	Return the type of the object to be created.
protected Content	_getParent(Map transientVars)	Get the parent content if exists.
protected String	_getParentAttributeName(Content parent)	Get the parent attribute name.
protected 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 smanager)

Methods inherited from class org.ametys.odf.workflow.copy.AbstractCreateODFContentByCopyFunction

_createContent, _getContentRoot

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

execute, getAdditionalCopyMap, getBaseContentForCopy

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

_eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _getSubContentRoot, _initWorkflow, _isMultilingual, _notifyContentAdded, _populateAdditionalData, _populateContent, _setTitle, getArguments, getDescription, 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

Constructor Details

CreateOrgUnitByCopyFunction

public CreateOrgUnitByCopyFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractCreateODFContentByCopyFunction

Throws:

ServiceException

_getContentNamePrefix

protected String _getContentNamePrefix()

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the prefix for content name

Specified by:

_getContentNamePrefix in class AbstractCreateODFContentByCopyFunction

Returns:

the prefix

_getObjectType

protected String _getObjectType(Map transientVars,
 Map args)

Description copied from class: CreateContentFunction

Return the type of the object to be created. Ex: ametys:defaultContent.

Overrides:

_getObjectType in class CreateContentFunction

Parameters:

transientVars - The workflow vars

args - The workflow function arguments

Returns:

The type of the object to be used during content creation.

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 AbstractCreateODFContentByCopyFunction

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)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent content if exists.

Overrides:

_getParent in class AbstractCreateODFContentByCopyFunction

Parameters:

transientVars - The transient vars

Returns:

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

_isCompatibleParent

protected boolean _isCompatibleParent(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Check if the parent is compatible

Specified by:

_isCompatibleParent in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

true if the parent is compatible

_getParentAttributeName

protected String _getParentAttributeName(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent attribute name.

Specified by:

_getParentAttributeName in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

the parent attribute name

_buildParentSynchronizableValue

protected SynchronizableValue _buildParentSynchronizableValue(Content parent)

Description copied from class: AbstractCreateODFContentByCopyFunction

Get the parent attribute synchronizable value.

Specified by:

_buildParentSynchronizableValue in class AbstractCreateODFContentByCopyFunction

Parameters:

parent - The parent

Returns:

a synchronizable value