org.asteriskjava.fastagi.command

Class DatabaseDelTreeCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.DatabaseDelTreeCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class DatabaseDelTreeCommand
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
DatabaseDelTreeCommand(String family) Creates a new DatabaseDelCommand to delete a whole family.
DatabaseDelTreeCommand(String family, String keyTree) Creates a new DatabaseDelCommand to delete a keytree within a given family.

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 delete.
String	getKeyTree() Returns the the keytree to delete.
void	setFamily(String family) Sets the family of the key 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

DatabaseDelTreeCommand

public DatabaseDelTreeCommand(String family)

Creates a new DatabaseDelCommand to delete a whole family.

Parameters:

family - the family to delete.

DatabaseDelTreeCommand

public DatabaseDelTreeCommand(String family,
                              String keyTree)

Creates a new DatabaseDelCommand to delete a keytree within a given family.

Parameters:

family - the family of the keytree to delete.

keyTree - the keytree to delete.

Method Detail

getFamily

public String getFamily()

Returns the family of the key to delete.

Returns:

the family of the key to delete.

setFamily

public void setFamily(String family)

Sets the family of the key to delete.

Parameters:

family - the family of the key 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, null to delete the whole family.

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.