com.swath.cmd

Class SendPrivateMessage

java.lang.Object

com.swath.Info

com.swath.cmd.SendPrivateMessage

All Implemented Interfaces:

CommandIfc

public final class SendPrivateMessage
extends Info

Send a private message to a trader.
Prompts: Any prompt

Since:

SWATH 1.5

See Also:

SendFedCommMessage, SendSSRadioMessage, SendCorporateMemo

Method Summary

Modifier and Type	Method and Description
static void	exec(Trader trader, java.lang.String message) Send a plain message to a trader.
static void	exec(Trader trader, java.lang.String message, boolean encrypt) Send a private message to a trader.
java.lang.String	getClassName() Gets the command class name.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
boolean	initCommand()
boolean	isInternal() Indicates if this is an internal SWATH command or not.
boolean	isUserDefined() Indicates if this command is user defined or not.

Methods inherited from class java.lang.Object

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

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static void exec(Trader trader,
                        java.lang.String message)
                 throws java.lang.Exception

Send a plain message to a trader.

Parameters:

trader - The trader that should receive the message.

message - The message to send.

Throws:

java.lang.Exception

Since:

SWATH 1.5

exec

public static void exec(Trader trader,
                        java.lang.String message,
                        boolean encrypt)
                 throws java.lang.Exception

Send a private message to a trader. The message could be sent in plain text or encrypted.

Parameters:

trader - The trader that should receive the message.

message - The message to send.

encrypt - true if the message should be encrypted, otherwise false.

Throws:

java.lang.Exception

Since:

SWATH 1.5

isUserDefined

public final boolean isUserDefined()

Description copied from interface: CommandIfc

Indicates if this command is user defined or not.

Specified by:

isUserDefined in interface CommandIfc

Returns:

true if user defined, otherwise false.

getName

public final java.lang.String getName()

Description copied from interface: CommandIfc

Gets the name of the command.

Specified by:

getName in interface CommandIfc

Returns:

The command name.

getClassName

public final java.lang.String getClassName()

Description copied from interface: CommandIfc

Gets the command class name.

Specified by:

getClassName in interface CommandIfc

Returns:

The class name.

getParams

public final java.util.Enumeration getParams()

Description copied from interface: CommandIfc

Gets the command parameters.

Specified by:

getParams in interface CommandIfc

Returns:

The command parameters.

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

Specified by:

isInternal in interface CommandIfc

Returns:

true if internal, otherwise false.