Package org.bonitasoft.engine.api.impl

Class PlatformCommandAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.PlatformCommandAPIImpl

All Implemented Interfaces:

org.bonitasoft.engine.api.PlatformCommandAPI

public class PlatformCommandAPIImpl
extends Object
implements org.bonitasoft.engine.api.PlatformCommandAPI

Author:

Matthieu Chaffotte, Zhang Bole, Emmanuel Duchastenier, Celine Souchet

Constructor Summary

Constructors

Constructor	Description
PlatformCommandAPIImpl()

Method Summary

Modifier and Type	Method	Description
void	addDependency(String name, byte[] jar)
Serializable	execute(String platformCommandName, Map<String,Serializable> parameters)
org.bonitasoft.engine.command.CommandDescriptor	getCommand(String platformCommandName)
List<org.bonitasoft.engine.command.CommandDescriptor>	getCommands(int startIndex, int maxResults, org.bonitasoft.engine.command.CommandCriterion sort)
org.bonitasoft.engine.command.CommandDescriptor	register(String name, String description, String implementation)
void	removeDependency(String name)
void	unregister(String platformCommandName)
void	update(String platformCommandName, org.bonitasoft.engine.command.CommandUpdater updater)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlatformCommandAPIImpl

public PlatformCommandAPIImpl()

Method Details

addDependency

public void addDependency(String name,
 byte[] jar)
                   throws org.bonitasoft.engine.exception.CreationException

Specified by:

addDependency in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.exception.CreationException

removeDependency

public void removeDependency(String name)
                      throws org.bonitasoft.engine.command.DependencyNotFoundException,
org.bonitasoft.engine.exception.DeletionException

Specified by:

removeDependency in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.command.DependencyNotFoundException

org.bonitasoft.engine.exception.DeletionException

register

public org.bonitasoft.engine.command.CommandDescriptor register(String name,
 String description,
 String implementation)
                                                         throws org.bonitasoft.engine.exception.CreationException

Specified by:

register in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.exception.CreationException

execute

public Serializable execute(String platformCommandName,
 Map<String,Serializable> parameters)
                     throws org.bonitasoft.engine.command.CommandNotFoundException,
org.bonitasoft.engine.command.CommandParameterizationException,
org.bonitasoft.engine.command.CommandExecutionException

Specified by:

execute in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.command.CommandNotFoundException

org.bonitasoft.engine.command.CommandParameterizationException

org.bonitasoft.engine.command.CommandExecutionException

unregister

public void unregister(String platformCommandName)
                throws org.bonitasoft.engine.command.CommandNotFoundException,
org.bonitasoft.engine.exception.DeletionException

Specified by:

unregister in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.command.CommandNotFoundException

org.bonitasoft.engine.exception.DeletionException

getCommand

public org.bonitasoft.engine.command.CommandDescriptor getCommand(String platformCommandName)
                                                           throws org.bonitasoft.engine.command.CommandNotFoundException

Specified by:

getCommand in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.command.CommandNotFoundException

getCommands

public List<org.bonitasoft.engine.command.CommandDescriptor> getCommands(int startIndex,
 int maxResults,
 org.bonitasoft.engine.command.CommandCriterion sort)

Specified by:

getCommands in interface org.bonitasoft.engine.api.PlatformCommandAPI

update

public void update(String platformCommandName,
 org.bonitasoft.engine.command.CommandUpdater updater)
            throws org.bonitasoft.engine.exception.UpdateException

Specified by:

update in interface org.bonitasoft.engine.api.PlatformCommandAPI

Throws:

org.bonitasoft.engine.exception.UpdateException