de.hybris.platform.webservices

Interface Command<RESOURCE,REQUEST,RESPONSE>

All Known Implementing Classes:

AbortCronJobCommand, AbstractCommand, CreateCronJobCommand, PlaceOrderCommand, StartCronJobCommand

public interface Command<RESOURCE,REQUEST,RESPONSE>

A command is a special kind of response which can be executed as part of a POST request.

Commands are registered at resource classes. Executing a command is done by it's name which must be passed as URL query parameter.

Method Summary

Modifier and Type	Method and Description
RESPONSE	execute(RESOURCE resourceEntity, REQUEST requestEntity) Executes a Command operation on an entity.
java.lang.String	getName() Returns the name of this command.

Method Detail

getName

java.lang.String getName()

Returns the name of this command.

Returns:

name of command

execute

RESPONSE execute(RESOURCE resourceEntity,
                 REQUEST requestEntity)
          throws java.lang.Exception

Executes a Command operation on an entity.

Parameters:

resourceEntity - this is the entity the command is executed for, it is always a Hybris Model

requestEntity - this is a parameter which is passed and shall be applied to the entity, as this is always a DTO it may itself provide many single parameters as DTO members

Returns:

the entity which shall be send to the client, this can be a DTO, a Hybris Model or null

Throws:

java.lang.Exception