org.ametys.plugins.contentio.synchronize

Interface SynchronizableContentsCollection

All Known Implementing Classes:

AbstractDataSourceSynchronizableContentsCollection, AbstractSynchronizableContentsCollection, LDAPSynchronizableContentsCollection, SQLSynchronizableContentsCollection, UserPopulationSynchronizableContentsCollection

public interface SynchronizableContentsCollection

This interface represents a synchronizable collection of contents

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_ID_PROPERTY The name for the metadata indicating the ids of the collections

Method Summary

Modifier and Type	Method and Description
String	getContentPrefix() Get the prefix to use for the creation of contents
String	getContentType() Get the type of content handled by this collection
Set<String>	getExternalOnlyFields() Get the path of field that are valued externally only.
String	getId() Get the id of synchronizable collection.
String	getIdField() Get the path of metadata holding the unique identifier
int	getInitialActionId() Get the id of the initial action of the workflow
I18nizableText	getLabel() Get the label of synchronizable collection
Set<String>	getLocalAndExternalFields() Get the path of tri-state fields (with local and external values)
Map<String,Object>	getParameterValues() Get the untyped values of parameters for controller
String	getReportMails() If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)
String	getRestrictedField() Get the path of boolean metadata for restricted content.
String	getSynchronizeCollectionModelId() Get the id of controller responsible of synchronization of this collection
String	getSynchronizingContentOperator() Gets the id of the SynchronizingContentOperator extension to use during synchronization
int	getValidateActionId() Get the id of the validate action of the workflow
String	getWorkflowName() Get the name of the workflow to use for the synchronized contents
void	populate(Logger logger) Populates contents
boolean	removalSync() When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.
boolean	validateAfterImport() True to validate the contents after import

Field Detail

COLLECTION_ID_PROPERTY

static final String COLLECTION_ID_PROPERTY

The name for the metadata indicating the ids of the collections

See Also:

Constant Field Values

Method Detail

getId

String getId()

Get the id of synchronizable collection.

Returns:

the id

getLabel

I18nizableText getLabel()

Get the label of synchronizable collection

Returns:

the label

getContentType

String getContentType()

Get the type of content handled by this collection

Returns:

the type of content

getSynchronizeCollectionModelId

String getSynchronizeCollectionModelId()

Get the id of controller responsible of synchronization of this collection

Returns:

The id of controller

getParameterValues

Map<String,Object> getParameterValues()

Get the untyped values of parameters for controller

Returns:

the untyped values

removalSync

boolean removalSync()

When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.

Returns:

true if a content created by a previous synchro has to be removed if it does not exist anymore during the current synchro.

getWorkflowName

String getWorkflowName()

Get the name of the workflow to use for the synchronized contents

Returns:

the name of the workflow to use for the synchronized contents

getInitialActionId

int getInitialActionId()

Get the id of the initial action of the workflow

Returns:

The id of the initial action of the workflow

getValidateActionId

int getValidateActionId()

Get the id of the validate action of the workflow

Returns:

The id of the validate action of the workflow

getContentPrefix

String getContentPrefix()

Get the prefix to use for the creation of contents

Returns:

The prefix to use for the creation of contents

validateAfterImport

boolean validateAfterImport()

True to validate the contents after import

Returns:

True to validate the contents after import

getReportMails

String getReportMails()

If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)

Returns:

The email addresses to send an error report if an exception occurs during synchronization (separated by new lines)

getSynchronizingContentOperator

String getSynchronizingContentOperator()

Gets the id of the SynchronizingContentOperator extension to use during synchronization

Returns:

the id of the SynchronizingContentOperator extension to use during synchronization

getRestrictedField

String getRestrictedField()

Get the path of boolean metadata for restricted content. If true, the content will be visible only for connected users.

Returns:

the path to the metadata. Can be null.

getIdField

String getIdField()

Get the path of metadata holding the unique identifier

Returns:

the path to the metadata. Can be null.

getLocalAndExternalFields

Set<String> getLocalAndExternalFields()

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

Returns:

the synchronized fields

getExternalOnlyFields

Set<String> getExternalOnlyFields()

Get the path of field that are valued externally only.

Returns:

the external fields

populate

void populate(Logger logger)

Populates contents

Parameters:

logger - The logger