com.brsanthu.googleanalytics.request.ExceptionHit Maven / Gradle / Ivy

/*
 * 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 com.brsanthu.googleanalytics.request;

import static com.brsanthu.googleanalytics.internal.Constants.HIT_EXCEPTION;
import static com.brsanthu.googleanalytics.request.GoogleAnalyticsParameter.EXCEPTION_DESCRIPTION;
import static com.brsanthu.googleanalytics.request.GoogleAnalyticsParameter.EXCEPTION_FATAL;

/**
 * GA request to track exceptions.
 *
 * 
 * For more information, see
 * GA Parameters
 * Reference
 * 
 *
 * @author Santhosh Kumar
 */
public class ExceptionHit extends GoogleAnalyticsRequest {

    public ExceptionHit() {
        this(null);
    }

    public ExceptionHit(String exceptionDescription) {
        this(exceptionDescription, false);
    }

    public ExceptionHit(String exceptionDescription, Boolean fatal) {
        super(HIT_EXCEPTION);
        exceptionDescription(exceptionDescription);
        exceptionFatal(fatal);
    }

    /**
     * 
     * 
     * Optional.
     * 
     * 
     * Specifies the description of an exception.
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * Parameter Value Type Default Value Max Length Supported Hit Types
exd text None 150 Bytes exception
     *  Example value: DatabaseError

     * Example usage: exd=DatabaseError 
 
     */
    public ExceptionHit exceptionDescription(String value) {
        setString(EXCEPTION_DESCRIPTION, value);
        return this;
    }

    public String exceptionDescription() {
        return getString(EXCEPTION_DESCRIPTION);
    }

    /**
     * 
     * 
     * Optional.
     * 
     * 
     * Specifies whether the exception was fatal.
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * Parameter Value Type Default Value Max Length Supported Hit Types
exf boolean 1 None exception
     *  Example value: 0

     * Example usage: exf=0 
 
     */
    public ExceptionHit exceptionFatal(Boolean value) {
        setBoolean(EXCEPTION_FATAL, value);
        return this;
    }

    public Boolean exceptionFatal() {
        return getBoolean(EXCEPTION_FATAL);
    }
}