org.asteriskjava.fastagi.command

Class DatabaseDelCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.DatabaseDelCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class DatabaseDelCommand
extends AbstractAgiCommand

Deletes a family or specific keytree within a family in the Asterisk database.

Returns 1 if successful, 0 otherwise.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DatabaseDelCommand(String family) Creates a new DatabaseDelCommand to delete a family.
DatabaseDelCommand(String family, String keyTree) Creates a new DatabaseDelCommand to delete a keytree.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getFamily() Returns the family (or family of the keytree) to delete.
String	getKeyTree() Returns the the keytree to delete.
void	setFamily(String family) Sets the family (or family of the keytree) to delete.
void	setKeyTree(String keyTree) Sets the keytree to delete.

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

DatabaseDelCommand

public DatabaseDelCommand(String family)

Creates a new DatabaseDelCommand to delete a family.

Parameters:

family - the family to delete.

DatabaseDelCommand

public DatabaseDelCommand(String family,
                          String keyTree)

Creates a new DatabaseDelCommand to delete a keytree.

Parameters:

family - the family of the keytree to delete.

keyTree - the keytree to delete.

Method Detail

getFamily

public String getFamily()

Returns the family (or family of the keytree) to delete.

Returns:

the family (or family of the keytree) to delete.

setFamily

public void setFamily(String family)

Sets the family (or family of the keytree) to delete.

Parameters:

family - the family (or family of the keytree) to delete.

getKeyTree

public String getKeyTree()

Returns the the keytree to delete.

Returns:

the keytree to delete.

setKeyTree

public void setKeyTree(String keyTree)

Sets the keytree to delete.

Parameters:

keyTree - the keytree to delete.

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.