Asterisk-Java

org.asteriskjava.fastagi.command
Class DatabaseDelTreeCommand

java.lang.Object
  extended by org.asteriskjava.fastagi.command.AbstractAgiCommand
      extended by org.asteriskjava.fastagi.command.DatabaseDelTreeCommand
All Implemented Interfaces:
java.io.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: DatabaseDelTreeCommand.java 1286 2009-04-04 09:40:40Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
DatabaseDelTreeCommand(java.lang.String family)
          Creates a new DatabaseDelCommand to delete a whole family.
DatabaseDelTreeCommand(java.lang.String family, java.lang.String keyTree)
          Creates a new DatabaseDelCommand to delete a keytree within a given family.
 
Method Summary
 java.lang.String buildCommand()
          Returns a string suitable to be sent to asterisk.
 java.lang.String getFamily()
          Returns the family of the key to delete.
 java.lang.String getKeyTree()
          Returns the the keytree to delete.
 void setFamily(java.lang.String family)
          Sets the family of the key to delete.
 void setKeyTree(java.lang.String keyTree)
          Sets the keytree to delete.
 
Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand
escapeAndQuote, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DatabaseDelTreeCommand

public DatabaseDelTreeCommand(java.lang.String family)
Creates a new DatabaseDelCommand to delete a whole family.

Parameters:
family - the family to delete.

DatabaseDelTreeCommand

public DatabaseDelTreeCommand(java.lang.String family,
                              java.lang.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 java.lang.String getFamily()
Returns the family of the key to delete.

Returns:
the family of the key to delete.

setFamily

public void setFamily(java.lang.String family)
Sets the family of the key to delete.

Parameters:
family - the family of the key to delete.

getKeyTree

public java.lang.String getKeyTree()
Returns the the keytree to delete.

Returns:
the keytree to delete.

setKeyTree

public void setKeyTree(java.lang.String keyTree)
Sets the keytree to delete.

Parameters:
keyTree - the keytree to delete, null to delete the whole family.

buildCommand

public java.lang.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.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.