org.asteriskjava.live.CallDetailRecord Maven / Gradle / Ivy

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.39.0
/*
 *  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.live;

import java.util.Date;

/**
 * Represents an Asterisk Call Detail Record (CDR).
 * 
 * @see org.asteriskjava.manager.event.CdrEvent
 * @author srt
 * @version $Id$
 * @since 0.3
 */
public interface CallDetailRecord
{
    AsteriskChannel getChannel();

    AsteriskChannel getDestinationChannel();

    /**
     * Returns the account number that is usually used to identify the party to bill for the call.
     * Corresponds to CDR field accountcode.
     * 
     * @return the account number.
     */
    String getAccountCode();

    AmaFlags getAmaFlags();

    /**
     * Returns the destination context.

     * Corresponds to CDR field dcontext.
     * 
     * @return the destination context.
     */
    String getDestinationContext();

    /**
     * Returns the destination extension.

     * Corresponds to CDR field dst.
     * 
     * @return the destination extension.
     */
    String getDestinationExtension();

    Disposition getDisposition();

    Date getStartDate();

    Date getAnswerDate();

    Date getEndDate();

    /**
     * Returns the total time (in seconds) the caller spent in the system from dial to hangup.

     * Corresponds to CDR field duration.
     * 
     * @return the total time in system in seconds.
     */
    Integer getDuration();

    /**
     * Returns the total time (in seconds) the call was up from answer to hangup.

     * Corresponds to CDR field billsec.
     * 
     * @return the total time in call in seconds.
     */
    Integer getBillableSeconds();

    /**
     * Returns the last application if appropriate, for example "VoiceMail".

     * Corresponds to CDR field lastapp.
     * 
     * @return the last application or null if not avaialble.
     */
    String getLastApplication();

    /**
     * Returns the last application's data (arguments), for example "s1234".

     * Corresponds to CDR field lastdata.
     * 
     * @return the last application's data or null if not avaialble.
     */
    String getLastAppData();

    /**
     * Returns the user-defined field as set by Set(CDR(userfield)=Value).
     * Corresponds to CDR field userfield.
     * 
     * @return the user-defined field.
     */
    String getUserField();
}