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

Class AbstractApogeeStructure

java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.odfsync.export.AbstractExportStructure
org.ametys.plugins.odfsync.apogee.ws.structure.AbstractApogeeStructure
All Implemented Interfaces:
LogEnabled, Serviceable
Direct Known Subclasses:
ApogeeContainerStructure, ApogeeDefaultStructure, ApogeeFullStructure, ApogeeSingleProgramStructure
public abstract class AbstractApogeeStructure extends AbstractExportStructure
The abstract class to handle an export in Apogee

  • Field Details

  • Constructor Details

  • Method Details

    • service

      public void service(ServiceManager manager) throws ServiceException
      Specified by:
      service in interface Serviceable
      Overrides:
      service in class AbstractExportStructure
      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

    • 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, ExportReport 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 void checkContainerAsYear(Container container, ExportReport report, String containerNatureCode)
      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
      containerNatureCode - The container nature code

    • checkContainerAsSemester

      public void checkContainerAsSemester(Container container, ExportReport report, String containerNatureCode)
      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
      containerNatureCode - The container nature code

    • checkCourseList

      public void checkCourseList(CourseList courseList, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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, ExportReport 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

    • checkContainerSemester

      protected boolean checkContainerSemester(String containerNatureCode, ExportReport report)
      Check if the container is a semester and set the exportStatus to CONTENT_STRUCTURE_INVALID if the container nature code cannot be found
      Parameters:
      containerNatureCode - The container nature code
      report - The ExportReport that contains the exportStatus
      Returns:
      true if the container is a semester, false if it is not, and null if the container nature code could not be retrieved

    • checkContainerYear

      protected boolean checkContainerYear(String containerNatureCode, ExportReport report)
      Check if the container is a year and set the exportStatus to CONTENT_STRUCTURE_INVALID if the container nature code cannot be found
      Parameters:
      containerNatureCode - The container nature code
      report - The ExportReport that contains the exportStatus
      Returns:
      true if the container is a year, false if it is not, and null if the container nature code could not be retrieved