org.bonitasoft.engine.command

Interface CommandDescriptor

All Superinterfaces:

BonitaObject, Serializable

All Known Implementing Classes:

CommandDescriptorImpl

public interface CommandDescriptor
extends BonitaObject

Represents the descriptor of a (tenant) command or a platform command.

Since:

6.0.0

Author:

Zhang Bole, Emmanuel Duchastenier

See Also:

CommandAPI

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the description of the command
long	getId() Get the identifier of this CommandDescriptor
String	getImplementation() Get the implementation class name of the command
String	getName() Get the name of the command
boolean	isSystemCommand() Is the command a default system command or a custom command.

Method Detail

getId

long getId()

Get the identifier of this CommandDescriptor

Returns:

the if of this CommandDescriptor

getName

String getName()

Get the name of the command

Returns:

the name of the command

getDescription

String getDescription()

Get the description of the command

Returns:

the description of the command

getImplementation

String getImplementation()

Get the implementation class name of the command

Returns:

the implementation class name of the command

isSystemCommand

boolean isSystemCommand()

Is the command a default system command or a custom command.

Returns:

true if this is a default system command, false otherwise.