net.sf.asterisk.fastagi.command
Class DatabaseDelCommand

java.lang.Object
  net.sf.asterisk.fastagi.command.AGICommand
      net.sf.asterisk.fastagi.command.DatabaseDelCommand

All Implemented Interfaces:

java.io.Serializable

public class DatabaseDelCommand
extends AGICommand

Deletes a family or specific keytree within a family in the Asterisk database.
Returns 1 if successful, 0 otherwise.

Version:

$Id: DatabaseDelCommand.java,v 1.2 2005/03/08 16:48:34 srt Exp $

Author:

srt

See Also:

Serialized Form

Constructor Summary

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

DatabaseDelCommand(java.lang.String family, java.lang.String keyTree)
Creates a new DatabaseDelCommand to delete a keytree.

Method Summary

java.lang.String	buildCommand() Returns a string suitable to be sent to asterisk.
java.lang.String	getFamily() Returns the family (or family of the keytree) to delete.
java.lang.String	getKeyTree() Returns the the keytree to delete.
void	setFamily(java.lang.String family) Sets the family (or family of the keytree) to delete.
void	setKeyTree(java.lang.String keyTree) Sets the keytree to delete.

Methods inherited from class net.sf.asterisk.fastagi.command.AGICommand

escapeAndQuote, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseDelCommand

public DatabaseDelCommand(java.lang.String family)

Creates a new DatabaseDelCommand to delete a family.

Parameters:

family - the family to delete.

DatabaseDelCommand

public DatabaseDelCommand(java.lang.String family,
                          java.lang.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 java.lang.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(java.lang.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 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.

buildCommand

public java.lang.String buildCommand()

Description copied from class: AGICommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in class AGICommand

Returns:

a string suitable to be sent to asterisk.