Package org.ametys.plugins.odfsync.export

Class ExportReport

java.lang.Object

org.ametys.plugins.odfsync.export.ExportReport

public class ExportReport
extends Object

The report for an export to an external connector (Pégase, Apogée...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExportReport.ExportStatus	The status of the export
static enum	ExportReport.ProblemTypes	Problem types that we can encounter

Constructor Summary

Constructors

Constructor	Description
ExportReport(Content content)	The constructor

Method Summary

Modifier and Type	Method	Description
void	addElementExported(Content element)	Add an element to the element exported
void	addInvalidDataPath(Content content, I18nizableText invalidMessage)	Add invalid model item for a content
Content	getContent()	Get the content in which the report is based
AbstractExportStructure	getExportStructure()	Get the structure implementation.
Map<Content,Set<I18nizableText>>	getInvalidDataPathByContent()	Get the invalid data by content
int	getNbExported()	Getter of nbExported
int	getNbNotExported()	Getter of _nbNotExported
int	getNbPartlyExported()	Getter of nbPartiallyExported
Set<ExportReport.ProblemTypes>	getProblemsEncountered()	Getter of _problemsEncountered
ExportReport.ExportStatus	getStatus()	Get the export status
void	setExportStructure(AbstractExportStructure structure)	Set the structure implementation.
void	setNbTotal(int nbTotal)	setter of _nbTotal
void	setStatus(ExportReport.ExportStatus status)	Set the export status
void	updateExportReport(ExportReport.ExportStatus exportStatusWanted, ExportReport.ProblemTypes problemEncountered)	Update the export report by setting the status and problem encountered
void	updateExportReport(ExportReport.ExportStatus exportStatusWanted, ExportReport.ProblemTypes problemEncountered, Content content)	Update the export report by setting the status, problemsEncountered and removing content from elementExported and adding it to elementPartlyExported
void	updateStatus(ExportReport.ExportStatus status)	Update the export status

Methods inherited from class java.lang.Object

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

Constructor Details

ExportReport

public ExportReport(Content content)

The constructor

Parameters:

content - The content on which the report is based

Method Details

getContent

public Content getContent()

Get the content in which the report is based

Returns:

a content

getInvalidDataPathByContent

public Map<Content,Set<I18nizableText>> getInvalidDataPathByContent()

Get the invalid data by content

Returns:

the map of invalid data by content

addInvalidDataPath

public void addInvalidDataPath(Content content,
 I18nizableText invalidMessage)

Add invalid model item for a content

Parameters:

content - the content

invalidMessage - the model item

getExportStructure

public AbstractExportStructure getExportStructure()

Get the structure implementation.

Returns:

the structure implementation

setExportStructure

public void setExportStructure(AbstractExportStructure structure)

Set the structure implementation.

Parameters:

structure - the structure implementation.

getStatus

public ExportReport.ExportStatus getStatus()

Get the export status

Returns:

the export status

setStatus

public void setStatus(ExportReport.ExportStatus status)

Set the export status

Parameters:

status - the export status

getNbExported

public int getNbExported()

Getter of nbExported

Returns:

The number of element exported

getNbPartlyExported

public int getNbPartlyExported()

Getter of nbPartiallyExported

Returns:

The number of partly exported element

getNbNotExported

public int getNbNotExported()

Getter of _nbNotExported

Returns:

The number of element not exported

setNbTotal

public void setNbTotal(int nbTotal)

setter of _nbTotal

Parameters:

nbTotal - The number

getProblemsEncountered

public Set<ExportReport.ProblemTypes> getProblemsEncountered()

Getter of _problemsEncountered

Returns:

The problems encountered

addElementExported

public void addElementExported(Content element)

Add an element to the element exported

Parameters:

element - The element to add

updateStatus

public void updateStatus(ExportReport.ExportStatus status)

Update the export status

Parameters:

status - The export status wanted

updateExportReport

public void updateExportReport(ExportReport.ExportStatus exportStatusWanted,
 ExportReport.ProblemTypes problemEncountered)

Update the export report by setting the status and problem encountered

Parameters:

exportStatusWanted - The export status wanted

problemEncountered - The problem encountered

updateExportReport

public void updateExportReport(ExportReport.ExportStatus exportStatusWanted,
 ExportReport.ProblemTypes problemEncountered,
 Content content)

Update the export report by setting the status, problemsEncountered and removing content from elementExported and adding it to elementPartlyExported

Parameters:

exportStatusWanted - The export status wanted

problemEncountered - The problem encountered

content - The content at cause