SynchronizeService (Nuxeo ECM Projects 5.5-SNAPSHOT API Documentation)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`doSynchronize(CoreSession session)` Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
`void`	`doSynchronize(CoreSession session, String queryName)` Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
`void`	`doSynchronize(CoreSession session, SynchronizeDetails details)` Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
`void`	`doSynchronize(CoreSession session, SynchronizeDetails details, String queryName)` Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
`void`	`doSynchronizeDocuments(CoreSession session)` Synchronizes all the documents by using the default synchronization details.
`void`	`doSynchronizeDocuments(CoreSession session, String queryName)` Synchronizes all the documents by using the default synchronization details.
`void`	`doSynchronizeDocuments(CoreSession session, SynchronizeDetails details)` Synchronizes all the documents by using the synchronization details.
`void`	`doSynchronizeDocuments(CoreSession session, SynchronizeDetails details, String queryName)` Synchronizes all the documents by using the synchronization details.
`void`	`doSynchronizeRelations()` Synchronizes all the relations defined on the documents by using the default synchronization details.This should happen after the documents synchronization.
`void`	`doSynchronizeRelations(SynchronizeDetails details)` Synchronizes all the relations defined on the documents by using the synchronization details.This should happen after the documents synchronization.
`void`	`doSynchronizeVocabularies()` Synchronizes all the vocabularies by using the default synchronization details.This should happen after the documents synchronization.
`void`	`doSynchronizeVocabularies(SynchronizeDetails details)` Synchronizes all the vocabularies by using the synchronization details.This should happen after the documents synchronization.
`SynchronizeDetails`	`getDefaultSynchronizeDetails()`
`boolean`	`shouldDisableReadSP(String docPath, String permission)` Test if the ReadSecurityPolicy should be disabled or not.

- Method Detail
  - doSynchronizeDocuments
```
void doSynchronizeDocuments(CoreSession session,
                          SynchronizeDetails details)
                            throws Exception
```
    Synchronizes all the documents by using the synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    details - - the details about the synchronization process
    
    Throws:
    
    ClientException
    
    Exception
  - doSynchronizeDocuments
```
void doSynchronizeDocuments(CoreSession session)
                            throws Exception
```
    Synchronizes all the documents by using the default synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    
    Throws:
    
    ClientException
    
    Exception
  - doSynchronizeDocuments
```
void doSynchronizeDocuments(CoreSession session,
                          SynchronizeDetails details,
                          String queryName)
                            throws Exception
```
    Synchronizes all the documents by using the synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    details - - the details about the synchronization process
    queryName - - the query name to use server side
    
    Throws:
    
    ClientException
    
    Exception
  - doSynchronizeDocuments
```
void doSynchronizeDocuments(CoreSession session,
                          String queryName)
                            throws Exception
```
    Synchronizes all the documents by using the default synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    queryName - - the query name to use server side
    
    Throws:
    
    ClientException
    
    Exception
  - doSynchronizeRelations
```
void doSynchronizeRelations(SynchronizeDetails details)
                            throws ClientException
```
    Synchronizes all the relations defined on the documents by using the synchronization details.This should happen after the documents synchronization.
    
    Parameters:
    details - - the details about the synchronization process
    
    Throws:
    
    ClientException
  - doSynchronizeRelations
```
void doSynchronizeRelations()
                            throws ClientException
```
    Synchronizes all the relations defined on the documents by using the default synchronization details.This should happen after the documents synchronization.
    
    Throws:
    
    ClientException
  - doSynchronizeVocabularies
```
void doSynchronizeVocabularies(SynchronizeDetails details)
                               throws ClientException
```
    Synchronizes all the vocabularies by using the synchronization details.This should happen after the documents synchronization.
    
    Parameters:
    details -
    
    Throws:
    
    ClientException
  - doSynchronizeVocabularies
```
void doSynchronizeVocabularies()
                               throws ClientException
```
    Synchronizes all the vocabularies by using the default synchronization details.This should happen after the documents synchronization.
    
    Throws:
    
    ClientException
  - doSynchronize
```
void doSynchronize(CoreSession session,
                 SynchronizeDetails details)
                   throws Exception
```
    Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    details - - the details about the synchronization process
    
    Throws:
    
    Exception
  - doSynchronize
```
void doSynchronize(CoreSession session)
                   throws Exception
```
    Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    
    Throws:
    
    Exception
  - doSynchronize
```
void doSynchronize(CoreSession session,
                 SynchronizeDetails details,
                 String queryName)
                   throws Exception
```
    Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    details - - the details about the synchronization process
    
    Throws:
    
    Exception
  - doSynchronize
```
void doSynchronize(CoreSession session,
                 String queryName)
                   throws Exception
```
    Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
    
    Parameters:
    session - - the Nuxeo core session received from the web context
    
    Throws:
    
    Exception
  - getDefaultSynchronizeDetails
```
SynchronizeDetails getDefaultSynchronizeDetails()
```
  - shouldDisableReadSP
```
boolean shouldDisableReadSP(String docPath,
                          String permission)
```
    Test if the ReadSecurityPolicy should be disabled or not.
    
    Parameters:
    docPath - the document path to test
    permission - the permission to test
    
    Returns:
    true if the ReadSecurityPolicy must be disabled, false otherwise

Interface SynchronizeService

Method Summary

Method Detail

doSynchronizeDocuments

doSynchronizeDocuments

doSynchronizeDocuments

doSynchronizeDocuments

doSynchronizeRelations

doSynchronizeRelations

doSynchronizeVocabularies

doSynchronizeVocabularies

doSynchronize

doSynchronize

doSynchronize

doSynchronize

getDefaultSynchronizeDetails

shouldDisableReadSP