Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.client.api.builder
Interface MessageBuildCommand<R>

All Superinterfaces:
MessageBuild, MessageBuildParms<R>, Sendable

public interface MessageBuildCommand<R>
extends MessageBuildParms<R>

This interface is a template for building the command part of a message. This ensures that the call is constructed properly.

Part of the fluent API centered around MessageBuilder.


Method Summary
 MessageBuildParms<R> command(Enum<?> command)
          Sets the command for the message, and returns an instance of MessageBuildParms, which needs to be constructed following setting the command.
 MessageBuildParms<R> command(String command)
          Sets the command for the message, and returns an instance of MessageBuildParms, which needs to be constructed following setting the command.
 MessageBuildParms<R> signalling()
          If signalling is called, the service is only signalled as opposed to sending a specific command.
 
Methods inherited from interface org.jboss.errai.bus.client.api.builder.MessageBuildParms
copy, copy, copyResource, defaultErrorHandling, done, errorsHandledBy, flag, noErrorHandling, with, with, withProvided, withProvided, withValue
 
Methods inherited from interface org.jboss.errai.bus.client.api.builder.MessageBuild
getMessage
 

Method Detail

command

MessageBuildParms<R> command(Enum<?> command)
Sets the command for the message, and returns an instance of MessageBuildParms, which needs to be constructed following setting the command.

Parameters:
command - the command to set for this message. Could be one of BusCommand
Returns:
an instance of MessageBuildParms

command

MessageBuildParms<R> command(String command)
Sets the command for the message, and returns an instance of MessageBuildParms, which needs to be constructed following setting the command.

Parameters:
command - the command to set for this message.
Returns:
an instance of MessageBuildParms

signalling

MessageBuildParms<R> signalling()
If signalling is called, the service is only signalled as opposed to sending a specific command.

Returns:
an instance of MessageBuildParms

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.