Package org.ametys.plugins.odfsync.apogee.ws.structure

Class AbstractApogeeStructure

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfsync.apogee.ws.structure.AbstractApogeeStructure

All Implemented Interfaces:

ApogeeExportStructure, LogEnabled, Serviceable

Direct Known Subclasses:

ApogeeContainerStructure, ApogeeDefaultStructure, ApogeeFullStructure, ApogeeSingleProgramStructure

public abstract class AbstractApogeeStructure
extends AbstractLogEnabled
implements ApogeeExportStructure, Serviceable

The abstract class to handle an export in Apogee

Field Summary

Fields

Modifier and Type	Field	Description
protected ApogeeWS	_apogeeWS	The apogee WS
protected I18nUtils	_i18nUtils	The i18n utils
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver
static String	CODE_APOGEE_ATTRIBUTE_NAME	The attribute name for the code Apogee
static String	CODE_APOGEE_SEPARATOR	The separator between the code and the version
static String	VERSION_APOGEE_ATTRIBUTE_NAME	The false attribute name for the version Apogee

Constructor Summary

Constructors

Constructor	Description
AbstractApogeeStructure()

Method Summary

Modifier and Type	Method	Description
protected void	_checkSimpleData(Content content, String dataPath, ApogeeExportReport report)	Check if the content has a value for the simple data
protected void	_checkTableRef(Content content, String dataPath, ApogeeExportReport report)	Check if the content has a value for the simple table ref data
protected void	_checkVersionApogee(Content content, ApogeeExportReport report)	Check if the version Apogee exist in the Apogee code
protected void	_createCourse(Course course, Content parentApogee, gouv.education.apogee.commun.client.ws.creationse.CreationSEMetierServiceInterface creationService, ApogeeExportReport report)	Create a course in Apogee
protected void	_createCourseList(CourseList courseList, Content parentApogee, gouv.education.apogee.commun.client.ws.creationse.CreationSEMetierServiceInterface creationService, ApogeeExportReport report)	Create a course list in Apogee
abstract void	checkContainerAsSemester(Container container, ApogeeExportReport report)	Check if the container as semester has the good data and structure to be export in Apogee
abstract void	checkContainerAsYear(Container container, ApogeeExportReport report)	Check if the container as year has the good data and structure to be export in Apogee
void	checkCourse(Course course, ApogeeExportReport report)	Check if the course has the good data and structure to be export in Apogee
void	checkCourseList(CourseList courseList, ApogeeExportReport report)	Check if the course list has the good data and structure to be export in Apogee
void	checkMandatoryDataForContent(Content content, List<String> mandatoryData, ApogeeExportReport report)	Check if the content has a value for all mandatory data
void	checkMandatoryDataForOrgunits(Content content, List<String> orgUnits, List<String> mandatoryData, ApogeeExportReport report)	Check if the orgUnits has a value for all mandatory data
abstract void	checkSubProgram(SubProgram subProgram, ApogeeExportReport report)	Check if the subProgram has the good data and structure to be export in Apogee
String	getCodeApogee(Content content)	Get the code Apogee of the content
String	getContainerNatureCode(Container container, ApogeeExportReport report)	Get the code of the container nature
List<String>	getDIPMandatoryData(Content content)	Mandatory data to export a content in a DIP in Apogee
List<String>	getELPMandatoryData(Content content)	Mandatory data to export a content in a ELP in Apogee
List<String>	getETPMandatoryData(Content content)	Mandatory data to export a content in a ETP in Apogee
List<String>	getLSEMandatoryData(Content content)	Mandatory data to export a content in a LSE in Apogee
List<String>	getOrgUnitMandatoryDataForDIP()	Mandatory data to export an orgunit for a DIP in Apogee
List<String>	getOrgUnitMandatoryDataForELP()	Mandatory data to export an orgunit for a ELP in Apogee
List<String>	getOrgUnitMandatoryDataForETP()	Mandatory data to export an orgunit for a ETP in Apogee
List<String>	getVDIMandatoryData(Content content)	Mandatory data to export a content in a VDI in Apogee
Long	getVersionApogee(Content content)	Get the version, Apogee of the content
List<String>	getVETMandatoryData(Content content)	Mandatory data to export a content in a VET in Apogee
boolean	isSemesterContainer(Container container, ApogeeExportReport report)	True if the container has for nature "semestre"
boolean	isYearContainer(Container container, ApogeeExportReport report)	True if the container has for nature "annee"
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

Methods inherited from interface org.ametys.plugins.odfsync.apogee.ws.structure.ApogeeExportStructure

checkProgram, createProgram

Field Detail

CODE_APOGEE_ATTRIBUTE_NAME

public static final String CODE_APOGEE_ATTRIBUTE_NAME

The attribute name for the code Apogee

See Also:

Constant Field Values

VERSION_APOGEE_ATTRIBUTE_NAME

public static final String VERSION_APOGEE_ATTRIBUTE_NAME

The false attribute name for the version Apogee

See Also:

Constant Field Values

CODE_APOGEE_SEPARATOR

public static final String CODE_APOGEE_SEPARATOR

The separator between the code and the version

See Also:

Constant Field Values

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_apogeeWS

protected ApogeeWS _apogeeWS

The apogee WS

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper

Constructor Detail

AbstractApogeeStructure

public AbstractApogeeStructure()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getDIPMandatoryData

public List<String> getDIPMandatoryData(Content content)

Mandatory data to export a content in a DIP in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getVDIMandatoryData

public List<String> getVDIMandatoryData(Content content)

Mandatory data to export a content in a VDI in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getETPMandatoryData

public List<String> getETPMandatoryData(Content content)

Mandatory data to export a content in a ETP in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getVETMandatoryData

public List<String> getVETMandatoryData(Content content)

Mandatory data to export a content in a VET in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getLSEMandatoryData

public List<String> getLSEMandatoryData(Content content)

Mandatory data to export a content in a LSE in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getELPMandatoryData

public List<String> getELPMandatoryData(Content content)

Mandatory data to export a content in a ELP in Apogee

Parameters:

content - the content to export

Returns:

the list of mandatory data

getOrgUnitMandatoryDataForDIP

public List<String> getOrgUnitMandatoryDataForDIP()

Mandatory data to export an orgunit for a DIP in Apogee

Returns:

the list of mandatory data

getOrgUnitMandatoryDataForETP

public List<String> getOrgUnitMandatoryDataForETP()

Mandatory data to export an orgunit for a ETP in Apogee

Returns:

the list of mandatory data

getOrgUnitMandatoryDataForELP

public List<String> getOrgUnitMandatoryDataForELP()

Mandatory data to export an orgunit for a ELP in Apogee

Returns:

the list of mandatory data

getContainerNatureCode

public String getContainerNatureCode(Container container,
                                     ApogeeExportReport report)

Get the code of the container nature

Parameters:

container - the container

report - the Apogee export report

Returns:

the code of the nature

isYearContainer

public boolean isYearContainer(Container container,
                               ApogeeExportReport report)

True if the container has for nature "annee"

Parameters:

container - the container

report - the Apogee export report

Returns:

true if it's a year container

isSemesterContainer

public boolean isSemesterContainer(Container container,
                                   ApogeeExportReport report)

True if the container has for nature "semestre"

Parameters:

container - the container

report - the Apogee export report

Returns:

true if it's a semester container

getCodeApogee

public String getCodeApogee(Content content)

Get the code Apogee of the content

Parameters:

content - the content

Returns:

the code Apogee

getVersionApogee

public Long getVersionApogee(Content content)

Get the version, Apogee of the content

Parameters:

content - the content

Returns:

the version Apogee

checkSubProgram

public abstract void checkSubProgram(SubProgram subProgram,
                                     ApogeeExportReport report)

Check if the subProgram has the good data and structure to be export in Apogee

Parameters:

subProgram - the subProgram to check

report - the Apogee export report

checkContainerAsYear

public abstract void checkContainerAsYear(Container container,
                                          ApogeeExportReport report)

Check if the container as year has the good data and structure to be export in Apogee

Parameters:

container - the container to check

report - the Apogee export report

checkContainerAsSemester

public abstract void checkContainerAsSemester(Container container,
                                              ApogeeExportReport report)

Check if the container as semester has the good data and structure to be export in Apogee

Parameters:

container - the container to check

report - the Apogee export report

checkCourseList

public void checkCourseList(CourseList courseList,
                            ApogeeExportReport report)

Check if the course list has the good data and structure to be export in Apogee

Parameters:

courseList - the course list to check

report - the Apogee export report

checkCourse

public void checkCourse(Course course,
                        ApogeeExportReport report)

Check if the course has the good data and structure to be export in Apogee

Parameters:

course - the course to check

report - the Apogee export report

checkMandatoryDataForContent

public void checkMandatoryDataForContent(Content content,
                                         List<String> mandatoryData,
                                         ApogeeExportReport report)

Check if the content has a value for all mandatory data

Parameters:

content - the content to check

mandatoryData - the list of mandatory data path

report - the Apogee export report

_checkSimpleData

protected void _checkSimpleData(Content content,
                                String dataPath,
                                ApogeeExportReport report)

Check if the content has a value for the simple data

Parameters:

content - the content to check

dataPath - the data path

report - the Apogee export report

_checkTableRef

protected void _checkTableRef(Content content,
                              String dataPath,
                              ApogeeExportReport report)

Check if the content has a value for the simple table ref data

Parameters:

content - the content to check

dataPath - the data path

report - the Apogee export report

_checkVersionApogee

protected void _checkVersionApogee(Content content,
                                   ApogeeExportReport report)

Check if the version Apogee exist in the Apogee code

Parameters:

content - the content

report - the Apogee export report

checkMandatoryDataForOrgunits

public void checkMandatoryDataForOrgunits(Content content,
                                          List<String> orgUnits,
                                          List<String> mandatoryData,
                                          ApogeeExportReport report)

Check if the orgUnits has a value for all mandatory data

Parameters:

content - the content to check

orgUnits - the list of orgUnit to check

mandatoryData - the list of mandatory data path

report - the Apogee export report

_createCourseList

protected void _createCourseList(CourseList courseList,
                                 Content parentApogee,
                                 gouv.education.apogee.commun.client.ws.creationse.CreationSEMetierServiceInterface creationService,
                                 ApogeeExportReport report)
                          throws RemoteException

Create a course list in Apogee

Parameters:

courseList - the course list to create

parentApogee - the parent in Apogee

creationService - the service to create element in Apogee

report - the Apogee export report

Throws:

RemoteException - if an export error occurred

_createCourse

protected void _createCourse(Course course,
                             Content parentApogee,
                             gouv.education.apogee.commun.client.ws.creationse.CreationSEMetierServiceInterface creationService,
                             ApogeeExportReport report)
                      throws RemoteException

Create a course in Apogee

Parameters:

course - the course to create

parentApogee - the parent in Apogee

creationService - the service to create element in Apogee

report - the Apogee export report

Throws:

RemoteException - if an export error occurred