org.ametys.plugins.extraction.edition

Class EditExtractionClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.extraction.edition.EditExtractionClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class EditExtractionClientSideElement
extends StaticClientSideElement

This client site element manages a button to create an extraction definition file

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 and Description
private SourceResolver	_sourceResolver
static String	ROLE The Avalon role name

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

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

Constructor Summary

Constructors

Constructor and Description
EditExtractionClientSideElement()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	createExtraction(String definitionFileName) Creates an extraction definition file.
boolean	deleteExtraction(String definitionFileName) Deletes an extraction definition file.
Map<String,Object>	renameExtraction(String definitionOldFileName, String definitionNewFileName) Renames an extraction definition file.
void	service(ServiceManager serviceManager)

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, 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

ROLE

public static final String ROLE

The Avalon role name

_sourceResolver

private SourceResolver _sourceResolver

Constructor Detail

EditExtractionClientSideElement

public EditExtractionClientSideElement()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

createExtraction

public Map<String,Object> createExtraction(String definitionFileName)
                                    throws Exception

Creates an extraction definition file.

Parameters:

definitionFileName - The extraction definition name

Returns:

Map containing success boolean and error codes if one occurs

Throws:

Exception - if an error occurs

renameExtraction

public Map<String,Object> renameExtraction(String definitionOldFileName,
                                           String definitionNewFileName)
                                    throws Exception

Renames an extraction definition file.

Parameters:

definitionOldFileName - The extraction definition old file name

definitionNewFileName - The extraction definition new file name

Returns:

Map containing success boolean and error codes if one occurs

Throws:

Exception - if an error occurs

deleteExtraction

public boolean deleteExtraction(String definitionFileName)
                         throws Exception

Deletes an extraction definition file.

Parameters:

definitionFileName - The extraction definition file to delete

Returns:

true if extraction deletion succeed, false otherwise

Throws:

Exception - if an error occurs