org.ametys.plugins.odfsync.cdmfr.components

Interface ImportCDMFrComponent

All Known Implementing Classes:

AbstractImportCDMFrComponent, CoAccreditedRemoteImportCDMFrComponent, RemoteImportCDMFrComponent, SCCImportCDMFrComponent

public interface ImportCDMFrComponent

Interface for component to import a CDM-fr input stream.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Avalon Role

Method Summary

Modifier and Type	Method and Description
List<Expression>	getExpressionsList(String lang, String idValue, String contentType, String catalog) Construct the query to retrieve the content.
String	getIdField() Return the metadata identifier for CDM-fr synchronization.
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters) Get the path of tri-state fields (with local and external values)
Map<String,Object>	handleInputStream(InputStream input, Map<String,Object> parameters, Logger logger) Handle the CDM-fr input stream to import all the programs and its dependencies containing into it.

Field Detail

ROLE

static final String ROLE

Avalon Role

Method Detail

getIdField

String getIdField()

Return the metadata identifier for CDM-fr synchronization.

Returns:

The metadata name (cdmfrSyncCode)

getLocalAndExternalFields

Set<String> getLocalAndExternalFields(Map<String,Object> additionalParameters)

Get the path of tri-state fields (with local and external values)

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

handleInputStream

Map<String,Object> handleInputStream(InputStream input,
                                     Map<String,Object> parameters,
                                     Logger logger)
                              throws ProcessingException

Handle the CDM-fr input stream to import all the programs and its dependencies containing into it.

Parameters:

input - The CDM-fr input stream

parameters - The parameters useful for the operation

logger - The logger

Returns:

The list of imported/synchronized programs

Throws:

ProcessingException - If an error occurs

getExpressionsList

List<Expression> getExpressionsList(String lang,
                                    String idValue,
                                    String contentType,
                                    String catalog)

Construct the query to retrieve the content.

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

catalog - The catalog

Returns:

The List of Expression