com.softlayer.api.service.billing.currency.Country Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.billing.currency;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Billing_Currency_Country data type maps what currencies are valid for specific countries. US Dollars are valid from any country, but other currencies are only available to customers in certain countries. 
 *
 * @see SoftLayer_Billing_Currency_Country
 */
@ApiType("SoftLayer_Billing_Currency_Country")
public class Country extends Entity {

    /**
     * A unique identifier for the related country.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long countryId;

    public Long getCountryId() {
        return countryId;
    }

    public void setCountryId(Long countryId) {
        countryIdSpecified = true;
        this.countryId = countryId;
    }

    protected boolean countryIdSpecified;

    public boolean isCountryIdSpecified() {
        return countryIdSpecified;
    }

    public void unsetCountryId() {
        countryId = null;
        countryIdSpecified = false;
    }

    /**
     * A unique identifier for the related currency.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long currencyId;

    public Long getCurrencyId() {
        return currencyId;
    }

    public void setCurrencyId(Long currencyId) {
        currencyIdSpecified = true;
        this.currencyId = currencyId;
    }

    protected boolean currencyIdSpecified;

    public boolean isCurrencyIdSpecified() {
        return currencyIdSpecified;
    }

    public void unsetCurrencyId() {
        currencyId = null;
        currencyIdSpecified = false;
    }

    /**
     * A unique identifier for a map between a country and currency.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The country currency locale.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String locale;

    public String getLocale() {
        return locale;
    }

    public void setLocale(String locale) {
        localeSpecified = true;
        this.locale = locale;
    }

    protected boolean localeSpecified;

    public boolean isLocaleSpecified() {
        return localeSpecified;
    }

    public void unsetLocale() {
        locale = null;
        localeSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * The SoftLayer_Billing_Currency_Country service provides information about what currencies a customer in a specific country is eligible to use. 
     *
     * @see SoftLayer_Billing_Currency_Country
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Billing_Currency_Country")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * @see SoftLayer_Billing_Currency_Country::getCountriesWithListOfEligibleCurrencies
         */
        @ApiMethod
        public List getCountriesWithListOfEligibleCurrencies();

        /**
         * @see SoftLayer_Billing_Currency_Country::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Country getObject();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getCountriesWithListOfEligibleCurrencies}
         */
        public Future> getCountriesWithListOfEligibleCurrencies();

        public Future getCountriesWithListOfEligibleCurrencies(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask countryId() {
            withLocalProperty("countryId");
            return this;
        }

        public Mask currencyId() {
            withLocalProperty("currencyId");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask locale() {
            withLocalProperty("locale");
            return this;
        }

    }

}