Package org.ametys.odf.workflow

Class AbstractCreateODFContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.odf.workflow.AbstractCreateODFContentFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCreateODFProgramItemFunction, CreateCoursePartFunction, CreateOrgUnitFunction, CreatePersonFunction

public abstract class AbstractCreateODFContentFunction
extends CreateContentFunction

Abstract OSWorkflow function for creating a ODF 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
protected ODFHelper	_odfHelper	ODF helper
static final String	CONTENT_CATALOG_KEY	Constant for storing the catalog name to use into the transient variables map.

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

Method Summary

Modifier and Type	Method	Description
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.
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager manager)

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

_eventParamsForContentAdded, _getDefaultNameComputationMode, _getNameComputationMode, _getNonNullVar, _getObjectType, _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

Field Details

CONTENT_CATALOG_KEY

public static final String CONTENT_CATALOG_KEY

Constant for storing the catalog name to use into the transient variables map.

_odfHelper

protected ODFHelper _odfHelper

ODF helper

Constructor Details

AbstractCreateODFContentFunction

public AbstractCreateODFContentFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentFunction

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

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

Overrides:

execute in class CreateContentFunction

Throws:

com.opensymphony.workflow.WorkflowException

_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.

_getContentNamePrefix

protected abstract String _getContentNamePrefix()

Get the prefix for content name

Returns:

the prefix