Package org.ametys.plugins.odfsync.export

Class AbstractExportClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.cms.clientsideelement.AbstractContentClientSideElement

org.ametys.plugins.odfsync.export.AbstractExportClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Initializable, Configurable, Serviceable

Direct Known Subclasses:

ApogeeExportClientSideElement, PegaseExportClientSideElement

public abstract class AbstractExportClientSideElement
extends AbstractContentClientSideElement
implements Initializable

Client side element for connector export buttons

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 ContentTypeExtensionPoint	_ctExtPoint	The content type extension point
protected ServiceManager	_manager	The avalon service manager
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected AbstractStructureComponent	_structureComponent	The structure component (depending of the current implementation

Fields inherited from class org.ametys.cms.clientsideelement.AbstractContentClientSideElement

_contentHelper, _userManager

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
AbstractExportClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_getContentParams(Content content, Set<I18nizableText> invalidMessages)	Get content params
Map<String,Object>	exportProgram(String programId)	Export a program to external connector
protected abstract String	getActivateParam()	Get the name of the configuration parameter to check to associated buttons.
Map<String,Object>	getExportReportInfo(String programId)	Get the report informations of the export of the program id
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
protected abstract String	getStructureComponentRole()	Get the role of the structure component, depending of the implementation.
void	initialize()
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.clientsideelement.AbstractContentClientSideElement

getAllRightContentDescription, getContentDefaultParameters, getLockedContentDescription, getNoModifiableContentDescription, getNoRightContentDescription, hasRight, isLocked

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

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, 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 Details

_manager

protected ServiceManager _manager

The avalon service manager

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_ctExtPoint

protected ContentTypeExtensionPoint _ctExtPoint

The content type extension point

_structureComponent

protected AbstractStructureComponent _structureComponent

The structure component (depending of the current implementation

Constructor Details

AbstractExportClientSideElement

public AbstractExportClientSideElement()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentClientSideElement

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.

getActivateParam

protected abstract String getActivateParam()

Get the name of the configuration parameter to check to associated buttons.

Returns:

The name of the configuration parameter

getStructureComponentRole

protected abstract String getStructureComponentRole()

Get the role of the structure component, depending of the implementation.

Returns:

The role of the structure component

getExportReportInfo

public Map<String,Object> getExportReportInfo(String programId)

Get the report informations of the export of the program id

Parameters:

programId - the program id to export

Returns:

the export results

exportProgram

public Map<String,Object> exportProgram(String programId)

Export a program to external connector

Parameters:

programId - the program id to export

Returns:

the export results

_getContentParams

protected Map<String,Object> _getContentParams(Content content,
 Set<I18nizableText> invalidMessages)

Get content params

Parameters:

content - The content

invalidMessages - The modelItems

Returns:

parameters of the content