org.asteriskjava.manager.event.ResponseEvent 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.
The newest version!
/*
 *  Copyright 2004-2006 Stefan Reuter
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.asteriskjava.manager.event;

/**
 * Abstract base class for events triggered in response to a ManagerAction.
 * 
 * All ResponseEvents contain an additional action id property that links the
 * event to the action that caused it.
 *
 * @author srt
 * @version $Id$
 * @see org.asteriskjava.manager.action.ManagerAction
 */
public abstract class ResponseEvent extends ManagerEvent {
    private static final long serialVersionUID = 1L;
    protected String actionId;
    private String internalActionId;

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

    /**
     * Returns the user provided action id of the ManagerAction that caused this
     * event. If the application did not set an action id this method returns
     * null.
     *
     * @return the action id of the ManagerAction that caused this event or
     * null if none was set.
     * @see org.asteriskjava.manager.action.ManagerAction#setActionId(String)
     */
    public final String getActionId() {
        return actionId;
    }

    /**
     * Sets the action id of the ManagerAction that caused this event.
     *
     * @param actionId the action id of the ManagerAction that caused this
     *                 event.
     */
    public final void setActionId(String actionId) {
        this.actionId = actionId;
    }

    /**
     * Returns the internal action id of the ManagerAction that caused this
     * event.
     * 
     * Warning: This method is internal to Asterisk-Java and should never be
     * used in application code.
     *
     * @return the internal action id of the ManagerAction that caused this
     * event.
     * @since 0.2
     */
    public final String getInternalActionId() {
        return internalActionId;
    }

    /**
     * Sets the internal action id of the ManagerAction that caused this event.
     *
     * @param internalActionId the internal action id of the ManagerAction that
     *                         caused this event.
     * @since 0.2
     */
    public final void setInternalActionId(String internalActionId) {
        this.internalActionId = internalActionId;
    }
}