Package sk.ipesoft.d2000.d2japi
Interface D2TellCmdInfo
-
public interface D2TellCmdInfo
Human readable description of a single tell command.Tell command is by convention represented by single word identifier (name) optionally followed by arguments separated with spaces.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCommand()
Get name of the command.java.lang.String
getDescription()
Get human readable command description.java.lang.String
getParmDesc()
Get human readable description of tell command parameters.
-
-
-
Method Detail
-
getCommand
java.lang.String getCommand()
Get name of the command. Name also serves as identifier of the command, the first word in thecommand
passed toD2Session.tellCommand(String, String)
andD2Session.tellCommand(int, String)
.- Returns:
- command name
-
getParmDesc
java.lang.String getParmDesc()
Get human readable description of tell command parameters. Description of parameters in general is not machine processable since it doesn't follow any particular rules or convention.It is not translatable with D2000 dictionary.
- Returns:
- human readable description of command parameters
-
getDescription
java.lang.String getDescription()
Get human readable command description.It is not translatable with D2000 dictionary.
- Returns:
- human readable command description
-
-