org.ametys.odf

Class MigrateCoursePart

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.MigrateCoursePart

All Implemented Interfaces:

LogEnabled, Init, Serviceable

Direct Known Subclasses:

MigrateNatureEnseignement

public class MigrateCoursePart
extends AbstractLogEnabled
implements Init, Serviceable

Initialization class to migrate totalDurationOf* metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected OdfReferenceTableHelper	_odfRefTableHelper The ODF Reference table helper
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected ContentWorkflowHelper	_workflowHelper The content workflow helper
protected WorkflowProvider	_workflowProvider The workflow

Fields inherited from interface org.ametys.runtime.plugin.Init

ROLE

Constructor Summary

Constructors

Constructor and Description
MigrateCoursePart()

Method Summary

Modifier and Type	Method and Description
protected CoursePart	_createCoursePart(Course course, OdfReferenceTableEntry nature, Double totalDurationOf, boolean isLive) Create a course part linked to the course.
protected Map<String,String>	_createNatureEnseignementCategories() Create entries into the reference table EnseignementNature if they don't exist.
protected Map<String,OdfReferenceTableEntry>	_createNaturesEnseignement() Create entries into the reference table EnseignementNature if they don't exist.
protected Map<String,Object>	_doAction(WorkflowAwareContent content, Integer actionId) ContentWorkflowHelper cannot be used in these conditions.
protected Map<String,Pair<String,Long>>	_getNaturesEnseignementCategoryList() List of the course parts nature categories.
protected Map<String,Pair<String,String>>	_getNaturesEnseignementList() List of the course parts natures.
protected OdfReferenceTableEntry	_getOrCreateNatureEnseignement(String title, String code, Long order) Get or create the nature enseignement if it doesn't exist.
protected Map<String,CoursePart>	_migrateCoursePart(Course course, Map<String,OdfReferenceTableEntry> natureByCode, boolean isLive) Create a course part linked to the course.
protected void	_migrateCourseParts() Migrate the totalDurationOf to course parts.
protected void	_updateCoursePart(Course course, Map<String,OdfReferenceTableEntry> natureByCode, Map<String,CoursePart> createdCourseParts) Update the CoursePart and the course parts list of the Course with the values of the current version.
void	init() Method to be implemented by user Init class.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF Reference table helper

_workflowHelper

protected ContentWorkflowHelper _workflowHelper

The content workflow helper

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow

Constructor Detail

MigrateCoursePart

public MigrateCoursePart()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

init

public void init()
          throws Exception

Description copied from interface: Init

Method to be implemented by user Init class. Here you should manage the business part of your application init. As an Avalon component, class extending this interface have access to all Cocoon-managed components, all plugins, ...

Specified by:

init in interface Init

Throws:

Exception - if an error occurs

_migrateCourseParts

protected void _migrateCourseParts()
                            throws AmetysRepositoryException,
                                   com.opensymphony.workflow.WorkflowException,
                                   RepositoryException

Migrate the totalDurationOf to course parts.

Throws:

AmetysRepositoryException - if an error occurs

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

RepositoryException - if an error occurs

_updateCoursePart

protected void _updateCoursePart(Course course,
                                 Map<String,OdfReferenceTableEntry> natureByCode,
                                 Map<String,CoursePart> createdCourseParts)

Update the CoursePart and the course parts list of the Course with the values of the current version.

Parameters:

course - The Course to migrate

natureByCode - The course part natures

createdCourseParts - The Map of the created CoursePart previously

_migrateCoursePart

protected Map<String,CoursePart> _migrateCoursePart(Course course,
                                                    Map<String,OdfReferenceTableEntry> natureByCode,
                                                    boolean isLive)

Create a course part linked to the course.

Parameters:

course - The Course to migrate

natureByCode - The course part natures

isLive - Set the Live label if true

Returns:

The created course parts

_createCoursePart

protected CoursePart _createCoursePart(Course course,
                                       OdfReferenceTableEntry nature,
                                       Double totalDurationOf,
                                       boolean isLive)

Create a course part linked to the course.

Parameters:

course - The Course holder

nature - The nature of the course part

totalDurationOf - The number of hours

isLive - Set the Live label if true

Returns:

The CoursePart id

_createNaturesEnseignement

protected Map<String,OdfReferenceTableEntry> _createNaturesEnseignement()
                                                                 throws AmetysRepositoryException,
                                                                        com.opensymphony.workflow.WorkflowException

Create entries into the reference table EnseignementNature if they don't exist.

Returns:

The list of natures with their code and associated ID.

Throws:

AmetysRepositoryException - if an error occurs

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

_createNatureEnseignementCategories

protected Map<String,String> _createNatureEnseignementCategories()
                                                          throws AmetysRepositoryException,
                                                                 com.opensymphony.workflow.WorkflowException

Create entries into the reference table EnseignementNature if they don't exist.

Returns:

The list of natures with their code and associated ID.

Throws:

AmetysRepositoryException - if an error occurs

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

_getNaturesEnseignementList

protected Map<String,Pair<String,String>> _getNaturesEnseignementList()

List of the course parts natures.

Returns:

A Map with the code as a key, and a Pair with the title and the category code as a value

_getNaturesEnseignementCategoryList

protected Map<String,Pair<String,Long>> _getNaturesEnseignementCategoryList()

List of the course parts nature categories.

Returns:

A Map with the code as a key, and the title as a value

_doAction

protected Map<String,Object> _doAction(WorkflowAwareContent content,
                                       Integer actionId)
                                throws AmetysRepositoryException,
                                       com.opensymphony.workflow.WorkflowException

ContentWorkflowHelper cannot be used in these conditions.

Parameters:

content - The content

actionId - Action to perform

Returns:

The result map

Throws:

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

AmetysRepositoryException - if an error occurs

_getOrCreateNatureEnseignement

protected OdfReferenceTableEntry _getOrCreateNatureEnseignement(String title,
                                                                String code,
                                                                Long order)
                                                         throws AmetysRepositoryException,
                                                                com.opensymphony.workflow.WorkflowException

Get or create the nature enseignement if it doesn't exist. The code is tested.

Parameters:

title - The title of the nature

code - The code of the nature

order - The order to set.

Returns:

The corresponding entry

Throws:

AmetysRepositoryException - if an error occurs

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