org.bonitasoft.engine.platform.command

Interface PlatformCommandService

All Known Implementing Classes:

PlatformCommandServiceImpl

public interface PlatformCommandService

Author:

Zhang Bole, Emmanuel Duchastenier

Method Summary

Modifier and Type	Method and Description
void	create(SPlatformCommand command) Create a sPlatformCommand
void	delete(java.lang.String name) Delete a sPlatformCommand from its name
void	deleteAll() Delete all sPlatformCommands
SPlatformCommand	getPlatformCommand(java.lang.String name) Get sPlatformCommand by its name
java.util.List<SPlatformCommand>	getPlatformCommands(QueryOptions queryOptions) Get the sPlatformCommand having the given value for the given int index
void	update(SPlatformCommand command, EntityUpdateDescriptor updateDescriptor) Update a sPlatformCommand with given sPlatformCommand and new content.

Method Detail

create

void create(SPlatformCommand command)
     throws SPlatformCommandAlreadyExistsException,
            SPlatformCommandCreationException,
            SPlatformCommandGettingException

Create a sPlatformCommand

Parameters:

command -

Throws:

SPlatformCommandAlreadyExistsException - occurs when the sPlatformCommand has already been taken

SPlatformCommandCreationException - occurs when an exception is thrown during sPlatformCommand creation

SPlatformCommandGettingException - occurs when an exception is thrown during getting sPlatformCommand

Since:

6.0

delete

void delete(java.lang.String name)
     throws SPlatformCommandNotFoundException,
            SPlatformCommandDeletionException,
            SPlatformCommandGettingException

Delete a sPlatformCommand from its name

Parameters:

name - the platform name

Throws:

SPlatformCommandNotFoundException - occurs when the identifier does not refer to an existing sPlatformCommand

SPlatformCommandDeletionException - occurs when an exception is thrown during sPlatformCommand creation

SPlatformCommandGettingException - occurs when an exception is thrown during getting sPlatformCommand

Since:

6.0

deleteAll

void deleteAll()
        throws SPlatformCommandDeletionException

Delete all sPlatformCommands

Throws:

SPlatformCommandDeletionException - occurs when an exception is thrown during sPlatformCommand creation

Since:

6.0

getPlatformCommand

SPlatformCommand getPlatformCommand(java.lang.String name)
                             throws SPlatformCommandNotFoundException,
                                    SPlatformCommandGettingException

Get sPlatformCommand by its name

Parameters:

name -

Returns:

an entity of sPlatformCommand

Throws:

SPlatformCommandNotFoundException - occurs when the identifier does not refer to an existing sPlatformCommand

SPlatformCommandGettingException - occurs when an exception is thrown during getting sPlatformCommand

Since:

6.0

getPlatformCommands

java.util.List<SPlatformCommand> getPlatformCommands(QueryOptions queryOptions)
                                              throws SPlatformCommandGettingException

Get the sPlatformCommand having the given value for the given int index

Parameters:

queryOptions - criteria

Returns:

a list of sPlatformCommand

Throws:

SPlatformCommandGettingException - occurs when an exception is thrown during getting sPlatformCommand

Since:

6.0

update

void update(SPlatformCommand command,
            EntityUpdateDescriptor updateDescriptor)
     throws SPlatformCommandNotFoundException,
            SPlatformCommandUpdateException

Update a sPlatformCommand with given sPlatformCommand and new content.

Parameters:

command -

updateDescriptor -

Throws:

SPlatformCommandNotFoundException - occurs when the identifier does not refer to an existing sPlatformCommand

SPlatformCommandUpdateException - occurs when an exception is thrown during sPlatformCommand update

Since:

6.0