ApogeeGlobalSynchronizationClientSideElement (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.core.ui.StaticFileImportsClientSideElement
  - - org.ametys.core.ui.StaticClientSideElement
    - - org.ametys.core.ui.AddTaskClientSideElement
      - org.ametys.plugins.odfsync.apogee.ApogeeGlobalSynchronizationClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable
```
public class ApogeeGlobalSynchronizationClientSideElement
extends AddTaskClientSideElement
```
This implementation test if at least one SCC is instance of ApogeeSynchronizableContentsCollection If yes, the first collection is used to create the button, it there are no collections, the button is not displayed.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement
  ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields
Modifier and Type Field Description

protected SynchronizableContentsCollectionDAO _sccDAO
The SCC DAO
- Fields inherited from class org.ametys.core.ui.AddTaskClientSideElement
  _context
- Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
  _currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors
Constructor Description

ApogeeGlobalSynchronizationClientSideElement()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ClientSideElement.Script>`	`getScripts(boolean ignoreRights, Map<String,Object> contextParameters)`	This method return the scripts that will be used on client side.
`void`	`service(ServiceManager manager)`

Methods inherited from class org.ametys.core.ui.AddTaskClientSideElement
_configureClass, _configureDependencies, _configureScript, configureInitialParameters, contextualize, getDependencies

Methods inherited from class org.ametys.core.ui.StaticClientSideElement
_configureParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
_configureImports, _configureRights, _configureRightsMode, configure, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _sccDAO
```
protected SynchronizableContentsCollectionDAO _sccDAO
```
    The SCC DAO
- Constructor Detail
  - ApogeeGlobalSynchronizationClientSideElement
```
public ApogeeGlobalSynchronizationClientSideElement()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class StaticFileImportsClientSideElement
    
    Throws:
    
    ServiceException
  - getScripts
```
public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
                                                 Map<String,Object> contextParameters)
```
    Description copied from interface: ClientSideElement
    
    This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.
    
    Specified by:
    
    getScripts in interface ClientSideElement
    
    Overrides:
    
    getScripts in class StaticFileImportsClientSideElement
    
    Parameters:
    
    ignoreRights - True to ignore the rights verification.
    
    contextParameters - Contextuals parameters transmitted by the environment.
    
    Returns:
    
    The list of scripts or an empty list.