org.asteriskjava.manager.event.ListDialplanEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asterisk-java Show documentation
The free Java library for Asterisk PBX integration.
There is a newer version: 3.41.0
package org.asteriskjava.manager.event;

/**
 * A ShowDialplanCompleteEvent is triggered for each priority in the dialplan
 * in response to a ShowDialplanAction.
 * Available since Asterisk 1.6

 * It is implemented in main/pbx.c
 *
 * @author srt
 * @version $Id$
 * @see org.asteriskjava.manager.action.ShowDialplanAction
 * @see ShowDialplanCompleteEvent
 * @since 1.0.0
 */
public class ListDialplanEvent extends ResponseEvent
{
    private static final long serialVersionUID = 1L;

    private static final String PRIORITY_HINT = "hint";

    private String extension;
    private String extensionLabel;
    private boolean hint = false;
    private String application;
    private String appData;
    private String registrar;

    public ListDialplanEvent(Object source)
    {
        super(source);
    }

    /**
     * Returns the extension or extension pattern.
     *
     * @return the extension or extension pattern.
     */
    public String getExtension()
    {
        return extension;
    }

    public void setExtension(String extension)
    {
        this.extension = extension;
    }

    /**
     * Returns the extension label.
     * @return the extension label or null if none.
     */
    public String getExtensionLabel()
    {
        return extensionLabel;
    }

    public void setExtensionLabel(String extensionLabel)
    {
        this.extensionLabel = extensionLabel;
    }

    /**
     * Checks whether this is a hint.
     * @return true if this is a hint, false otherwise.
     */
    public boolean isHint()
    {
        return hint;
    }

    public void setPriority(String priorityString)
    {
        if (priorityString == null)
        {
            this.priority = null;
            return;
        }

        if (PRIORITY_HINT.equals(priorityString))
        {
            hint = true;
            this.priority = null;
        }
        else
        {
            this.priority = Integer.parseInt(priorityString);
        }
    }

    /**
     * Returns the application configured to handle this priority.
     *
     * @return the application configured to handle this priority.
     */
    public String getApplication()
    {
        return application;
    }

    public void setApplication(String application)
    {
        this.application = application;
    }

    /**
     * Returns the parameters of the application configured to handle this priority.
     *
     * @return the parameters of the application configured to handle this priority
     *         or null if none.
     */
    public String getAppData()
    {
        return appData;
    }

    public void setAppData(String appData)
    {
        this.appData = appData;
    }

    /**
     * Returns the registrar that registered this priority.
     * Typical values are "features" for the parkedcalls context, "pbx_config" for priorities
     * defined in extensions.conf or "app_dial" for the 
     * app_dial_gosub_virtual_context context.
     *
     * @return the registrar that registered this priority.
     */
    public String getRegistrar()
    {
        return registrar;
    }

    public void setRegistrar(String registrar)
    {
        this.registrar = registrar;
    }
}