Interface SynchronizableContentsCollection
- All Known Implementing Classes:
AbstractApogeeSynchronizableContentsCollection
,AbstractApogeeSynchronizableContentsWithCatalogCollection
,AbstractCDMFrSynchronizableContentsCollection
,AbstractDataSourceSynchronizableContentsCollection
,AbstractSimpleSynchronizableContentsCollection
,AbstractStaticSynchronizableContentsCollection
,AbstractSynchronizableContentsCollection
,CDMFrSynchronizableContentsCollection
,ContainerSynchronizableContentsCollection
,CourseListSynchronizableContentsCollection
,CourseSynchronizableContentsCollection
,LDAPSynchronizableContentsCollection
,LDAPSynchronizableUsersCollection
,OrgUnitSynchronizableContentsCollection
,PersonSynchronizableContentsCollection
,ProgramSynchronizableContentsCollection
,RemoteCDMFrSynchronizableContentsCollection
,SQLSynchronizableContentsCollection
,SQLSynchronizableUDOrgunitCollection
,SQLSynchronizableUsersCollection
,SubProgramSynchronizableContentsCollection
,UserPopulationSynchronizableContentsCollection
public interface SynchronizableContentsCollection
This interface represents a synchronizable collection of contents
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The name for the metadata indicating the ids of the collections -
Method Summary
Modifier and TypeMethodDescriptionvoid
Empty the collection of its synchronized contentsgetContent
(String lang, String idValue) Gets the content in the repositoryGet the prefix to use for the creation of contentsGet the type of content handled by this collectiongetExternalOnlyFields
(Map<String, Object> additionalParameters) Get the path of field that are valued externally only.getId()
Get the id of synchronizable collection.Get the path of metadata holding the unique identifierint
Get the id of the initial action of the workflowgetLabel()
Get the label of synchronizable collectionGet the languages handled by this collectiongetLocalAndExternalFields
(Map<String, Object> additionalParameters) Get the path of tri-state fields (with local and external values)Get the untyped values of parameters for controllerIf an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)Get the path of boolean metadata for restricted content.Get the search UI model for search tool (columns, criterias, url for buttons, etc.)int
Get the id of the synchronize action of the workflowGet the id of controller responsible of synchronization of this collectionGets the id of theSynchronizingContentOperator
extension to use during synchronizationint
getTotalCount
(Map<String, Object> parameters, Logger logger) Return the total number of results for the search.int
Get the id of the validate action of the workflowGet the name of the workflow to use for the synchronized contentsdefault boolean
Return true if aRightAssignmentContext
should be automatically generated for the contents of this SCCImport a content from remote values.Populates contentsboolean
When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.Search the data to import from parameters.void
synchronizeContent
(ModifiableDefaultContent content, Logger logger) Synchronize a content with remove values.boolean
True to synchronize only existing contentsvoid
updateSyncInformations
(ModifiableDefaultContent content, String syncCode, Logger logger) Method to update the synchronisation informations (collection and value of the ID field).boolean
True to validate the contents after import
-
Field Details
-
COLLECTION_ID_PROPERTY
The name for the metadata indicating the ids of the collections- See Also:
-
-
Method Details
-
getId
Get the id of synchronizable collection.- Returns:
- the id
-
getLabel
Get the label of synchronizable collection- Returns:
- the label
-
getContentType
Get the type of content handled by this collection- Returns:
- the type of content
-
getLanguages
Get the languages handled by this collection- Returns:
- the list of language
-
getSynchronizeCollectionModelId
Get the id of controller responsible of synchronization of this collection- Returns:
- The id of controller
-
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
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
-
getSynchronizeActionId
int getSynchronizeActionId()Get the id of the synchronize action of the workflow- Returns:
- The id of the synchronize 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
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
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
Gets the id of theSynchronizingContentOperator
extension to use during synchronization- Returns:
- the id of the
SynchronizingContentOperator
extension to use during synchronization
-
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
Get the path of metadata holding the unique identifier- Returns:
- the path to the metadata. Can be null.
-
getLocalAndExternalFields
Get the path of tri-state fields (with local and external values)- Parameters:
additionalParameters
- Additional parameters- Returns:
- the synchronized fields
-
getExternalOnlyFields
Get the path of field that are valued externally only.- Parameters:
additionalParameters
- Additional parameters- Returns:
- the external fields
-
getSearchModelConfiguration
Get the search UI model for search tool (columns, criterias, url for buttons, etc.)- Returns:
- A
SCCSearchModelConfiguration
-
synchronizeExistingContentsOnly
boolean synchronizeExistingContentsOnly()True to synchronize only existing contents- Returns:
- True to synchronize only existing contents
-
empty
Empty the collection of its synchronized contents- Parameters:
logger
- The logger
-
populate
Populates contents- Parameters:
logger
- The logger- Returns:
- Return the populated contents (imported or synchronized)
-
importContent
List<ModifiableDefaultContent> importContent(String idValue, Map<String, Object> additionalParameters, Logger logger) throws ExceptionImport a content from remote values.- Parameters:
idValue
- Id (for import/synchronization) of the content to importadditionalParameters
- Additional parameterslogger
- The logger- Returns:
- A list of created contents
- Throws:
Exception
- if an error occurs.
-
synchronizeContent
Synchronize a content with remove values.- Parameters:
content
- The content to synchronizelogger
- The logger- Throws:
Exception
- if an error occurs.
-
getContent
Gets the content in the repository- Parameters:
lang
- the languageidValue
- the content name- Returns:
- the content in the repository, or null if does not exist
-
search
Map<String,Map<String, searchObject>> (Map<String, Object> parameters, int offset, int limit, List<Object> sort, Logger logger) Search the data to import from parameters.- Parameters:
parameters
- Parameters for the searchoffset
- Begin of the searchlimit
- Number of resultssort
- Sort of results (ignored for LDAP results)logger
- The logger- Returns:
- A map of remote values by content
-
updateSyncInformations
void updateSyncInformations(ModifiableDefaultContent content, String syncCode, Logger logger) throws Exception Method to update the synchronisation informations (collection and value of the ID field).- Parameters:
content
- Content to updatesyncCode
- New synchronization codelogger
- The logger- Throws:
Exception
- if an error occurs.
-
getTotalCount
Return the total number of results for the search.- Parameters:
parameters
- Parameters for the searchlogger
- The logger- Returns:
- The total count
-
handleRightAssignmentContext
Return true if aRightAssignmentContext
should be automatically generated for the contents of this SCC- Returns:
- true to automatically generate a
RightAssignmentContext
. Return false if the rights of contents of this SCC are handle by its ownRightAssignmentContext
-