BaseRateErrorReason.java

// Copyright 2017 Google Inc. All Rights Reserved.
//
// 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.google.api.ads.dfp.jaxws.v201702;

import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;


/**
 * <p>Java class for BaseRateError.Reason.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * <p>
 * <pre>
 * <simpleType name="BaseRateError.Reason">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="INVALID_CURRENCY_CODE"/>
 *     <enumeration value="PRODUCT_TEMPLATE_ARCHIVED"/>
 *     <enumeration value="PRODUCT_PACKAGE_ITEM_ARCHIVED"/>
 *     <enumeration value="CANNOT_QUERY_ON_MULTIPLE_TYPES"/>
 *     <enumeration value="PRODUCT_PACKAGE_RATE_CARD_ASSOCIATION_MISSING"/>
 *     <enumeration value="UNSUPPORTED_OPERATION"/>
 *     <enumeration value="PRODUCT_PACKAGE_ACTIVE"/>
 *     <enumeration value="PRODUCT_TEMPLATE_BASE_RATE_NOT_FOUND"/>
 *     <enumeration value="PRODUCT_BASE_RATE_EXISTS"/>
 *     <enumeration value="INVALID_RATE_CARD_CHANNEL"/>
 *     <enumeration value="ZERO_MARKETPLACE_RATE_NOT_SUPPORTED"/>
 *     <enumeration value="UNKNOWN"/>
 *   </restriction>
 * </simpleType>
 * </pre>
 * 
 */
@XmlType(name = "BaseRateError.Reason")
@XmlEnum
public enum BaseRateErrorReason {


    /**
     * 
     *                 The currency code is invalid.
     *               
     * 
     */
    INVALID_CURRENCY_CODE,

    /**
     * 
     *                 Cannot create or activate a base rate if the product template is
     *                 archived.
     *               
     * 
     */
    PRODUCT_TEMPLATE_ARCHIVED,

    /**
     * 
     *                 Cannot create or activate a product package item base rate if the product
     *                 package item is archived.
     *               
     * 
     */
    PRODUCT_PACKAGE_ITEM_ARCHIVED,

    /**
     * 
     *                 The PQL statement can only contain one of {@code productTemplateId},
     *                 {@code productId} or {@code productPackageItemId}.
     *               
     * 
     */
    CANNOT_QUERY_ON_MULTIPLE_TYPES,

    /**
     * 
     *                 Product package must be associated with the rate card of the product
     *                 package item base rate.
     *                 <p>See {@link ProductPackage#rateCardIds}.
     *               
     * 
     */
    PRODUCT_PACKAGE_RATE_CARD_ASSOCIATION_MISSING,

    /**
     * 
     *                 Indicates that the requested operation is not supported.
     *               
     * 
     */
    UNSUPPORTED_OPERATION,

    /**
     * 
     *                 Cannot delete a product package item base rate when its product package
     *                 is active.
     *               
     * 
     */
    PRODUCT_PACKAGE_ACTIVE,

    /**
     * 
     *                 Cannot create a base rate to a product if its product template does not
     *                 have a base rate on this rate card.
     *               
     * 
     */
    PRODUCT_TEMPLATE_BASE_RATE_NOT_FOUND,

    /**
     * 
     *                 Cannot delete a base rate on a product template if its products still
     *                 have base rates on this rate card.
     *               
     * 
     */
    PRODUCT_BASE_RATE_EXISTS,

    /**
     * 
     *                 Marketplace {@link RateCard rate cards} should only have Marketplace
     *                 {@link Product}/{@link ProductTemplate} {@link BaseRate base rates}.
     *                 
     *                 Non-Marketplace {@link RateCard rate cards} should use traditional base rates.
     *               
     * 
     */
    INVALID_RATE_CARD_CHANNEL,

    /**
     * 
     *                 Marketplace does not support {@link BaseRate base rates} with zero-value rates.
     *               
     * 
     */
    ZERO_MARKETPLACE_RATE_NOT_SUPPORTED,

    /**
     * 
     *                 The value returned if the actual value is not exposed by the requested
     *                 API version.
     *               
     * 
     */
    UNKNOWN;

    public String value() {
        return name();
    }

    public static BaseRateErrorReason fromValue(String v) {
        return valueOf(v);
    }

}