Package org.ametys.odf.schedulable

Class EducationalBookletSchedulable.EducationalBookletReport

java.lang.Object

org.ametys.odf.schedulable.EducationalBookletSchedulable.EducationalBookletReport

Enclosing class:

EducationalBookletSchedulable

protected static class EducationalBookletSchedulable.EducationalBookletReport
extends Object

Object to represent list of programs exported and list of programs with error after PDF generation

Field Summary

Fields

Modifier and Type	Field	Description
private File	_bookletDirectory
private List<SubProgram>	_exportSubPrograms
private List<SubProgram>	_subProgramsWithError

Constructor Summary

Constructors

Constructor	Description
EducationalBookletReport(File bookletDirectory)	The constructor

Method Summary

Modifier and Type	Method	Description
void	addExportSubProgram(SubProgram subProgram)	Add subProgram to export subPrograms
void	addSubProgramWithError(SubProgram subProgram)	Add subProgram to subPrograms with error
File	getBookletDirectory()	Get the booklet directory
String	getCurrentStatus()	The current status of the educational booklet generation.
List<SubProgram>	getExportSubPrograms()	Get export subPrograms
List<SubProgram>	getSubProgramsWithError()	Get subPrograms with error
void	setExportSubProgram(List<SubProgram> subPrograms)	Set the export subPrograms

Methods inherited from class java.lang.Object

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

Field Detail

_bookletDirectory

private File _bookletDirectory

_exportSubPrograms

private List<SubProgram> _exportSubPrograms

_subProgramsWithError

private List<SubProgram> _subProgramsWithError

Constructor Detail

EducationalBookletReport

public EducationalBookletReport(File bookletDirectory)

The constructor

Parameters:

bookletDirectory - The booklet directory

Method Detail

getBookletDirectory

public File getBookletDirectory()

Get the booklet directory

Returns:

the booklet directory

getExportSubPrograms

public List<SubProgram> getExportSubPrograms()

Get export subPrograms

Returns:

the list of export subPrograms

addExportSubProgram

public void addExportSubProgram(SubProgram subProgram)

Add subProgram to export subPrograms

Parameters:

subProgram - the subProgram to add

setExportSubProgram

public void setExportSubProgram(List<SubProgram> subPrograms)

Set the export subPrograms

Parameters:

subPrograms - the list of export subPrograms

getSubProgramsWithError

public List<SubProgram> getSubProgramsWithError()

Get subPrograms with error

Returns:

the list of subPrograms with error

addSubProgramWithError

public void addSubProgramWithError(SubProgram subProgram)

Add subProgram to subPrograms with error

Parameters:

subProgram - the subProgram to add

getCurrentStatus

public String getCurrentStatus()

The current status of the educational booklet generation. - FAILURE: No subprograms with errors - SUCCESS: All subprograms are successfully generated - SUCCESS_WITH_ERRORS: Some subprograms are successfully generated but not all of them

Returns:

A String representing the status