org.asteriskjava.fastagi.command

Class GetFullVariableCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.GetFullVariableCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class GetFullVariableCommand
extends AbstractAgiCommand

Returns the value of the given channel varible and understands complex variable names and builtin variables, unlike the GetVariableCommand.

You can also use this command to use custom Asterisk functions. Syntax is "func(args)".

Returns 0 if the variable is not set or channel does not exist. Returns 1 if the variable is set and returns the variable in parenthesis.

Available since Asterisk 1.2

Example return code: 200 result=1 (testvariable)

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

GetVariableCommand, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFullVariableCommand(String variable) Creates a new GetFullVariableCommand.
GetFullVariableCommand(String variable, String channel) Creates a new GetFullVariableCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getChannel() Returns the the name of the channel.
String	getVariable() Returns the name of the variable to retrieve.
void	setChannel(String channel) Sets the name of the channel.
void	setVariable(String variable) Sets the name of the variable to retrieve.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetFullVariableCommand

public GetFullVariableCommand(String variable)

Creates a new GetFullVariableCommand.

Parameters:

variable - the name of the variable to retrieve.

GetFullVariableCommand

public GetFullVariableCommand(String variable,
                              String channel)

Creates a new GetFullVariableCommand.

Parameters:

variable - the name of the variable to retrieve.

channel - the name of the channel.

Method Detail

getVariable

public String getVariable()

Returns the name of the variable to retrieve.

Returns:

the the name of the variable to retrieve.

setVariable

public void setVariable(String variable)

Sets the name of the variable to retrieve.

You can also use custom dialplan functions (like "func(args)") as variable.

Parameters:

variable - the name of the variable to retrieve.

getChannel

public String getChannel()

Returns the the name of the channel.

Returns:

the name of the channel.

setChannel

public void setChannel(String channel)

Sets the name of the channel.

Parameters:

channel - the name of the channel.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.