org.asteriskjava.fastagi.command

Class DatabaseGetCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.DatabaseGetCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class DatabaseGetCommand
extends AbstractAgiCommand

Retrieves an entry in the Asterisk database for a given family and key.

Returns 0 if is not set. Returns 1 if the variable is set and returns the value in parenthesis.

Example return code: 200 result=1 (testvariable)

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DatabaseGetCommand(String family, String key) Creates a new DatabaseGetCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getFamily() Returns the family of the key to retrieve.
String	getKey() Returns the the key to retrieve.
void	setFamily(String family) Sets the family of the key to retrieve.
void	setKey(String key) Sets the key 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

DatabaseGetCommand

public DatabaseGetCommand(String family,
                          String key)

Creates a new DatabaseGetCommand.

Parameters:

family - the family of the key to retrieve.

key - the key to retrieve.

Method Detail

getFamily

public String getFamily()

Returns the family of the key to retrieve.

Returns:

the family of the key to retrieve.

setFamily

public void setFamily(String family)

Sets the family of the key to retrieve.

Parameters:

family - the family of the key to retrieve.

getKey

public String getKey()

Returns the the key to retrieve.

Returns:

the key to retrieve.

setKey

public void setKey(String key)

Sets the key to retrieve.

Parameters:

key - the key to retrieve.

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.