com.softlayer.api.service.brand.business.Partner 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.brand.business;

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.Brand;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.business.partner.Channel;
import com.softlayer.api.service.business.partner.Segment;
import java.util.concurrent.Future;

/**
 * Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. 
 *
 * @see SoftLayer_Brand_Business_Partner
 */
@ApiType("SoftLayer_Brand_Business_Partner")
public class Partner extends Entity {

    /**
     * Brand associated with the business partner data
     */
    @ApiProperty
    protected Brand brand;

    public Brand getBrand() {
        return brand;
    }

    public void setBrand(Brand brand) {
        this.brand = brand;
    }

    /**
     * Channel indicator used to categorize business partner revenue.
     */
    @ApiProperty
    protected Channel channel;

    public Channel getChannel() {
        return channel;
    }

    public void setChannel(Channel channel) {
        this.channel = channel;
    }

    /**
     * Segment indicator used to categorize business partner revenue.
     */
    @ApiProperty
    protected Segment segment;

    public Segment getSegment() {
        return segment;
    }

    public void setSegment(Segment segment) {
        this.segment = segment;
    }

    /**
     * Brand business partner channel identifier 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long channelId;

    public Long getChannelId() {
        return channelId;
    }

    public void setChannelId(Long channelId) {
        channelIdSpecified = true;
        this.channelId = channelId;
    }

    protected boolean channelIdSpecified;

    public boolean isChannelIdSpecified() {
        return channelIdSpecified;
    }

    public void unsetChannelId() {
        channelId = null;
        channelIdSpecified = false;
    }

    /**
     * Brand business partner country enterprise code 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String countryEnterpriseCode;

    public String getCountryEnterpriseCode() {
        return countryEnterpriseCode;
    }

    public void setCountryEnterpriseCode(String countryEnterpriseCode) {
        countryEnterpriseCodeSpecified = true;
        this.countryEnterpriseCode = countryEnterpriseCode;
    }

    protected boolean countryEnterpriseCodeSpecified;

    public boolean isCountryEnterpriseCodeSpecified() {
        return countryEnterpriseCodeSpecified;
    }

    public void unsetCountryEnterpriseCode() {
        countryEnterpriseCode = null;
        countryEnterpriseCodeSpecified = false;
    }

    /**
     * Reseller level of a brand business partner 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long resellerLevel;

    public Long getResellerLevel() {
        return resellerLevel;
    }

    public void setResellerLevel(Long resellerLevel) {
        resellerLevelSpecified = true;
        this.resellerLevel = resellerLevel;
    }

    protected boolean resellerLevelSpecified;

    public boolean isResellerLevelSpecified() {
        return resellerLevelSpecified;
    }

    public void unsetResellerLevel() {
        resellerLevel = null;
        resellerLevelSpecified = false;
    }

    /**
     * Brand business partner segment identifier 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long segmentId;

    public Long getSegmentId() {
        return segmentId;
    }

    public void setSegmentId(Long segmentId) {
        segmentIdSpecified = true;
        this.segmentId = segmentId;
    }

    protected boolean segmentIdSpecified;

    public boolean isSegmentIdSpecified() {
        return segmentIdSpecified;
    }

    public void unsetSegmentId() {
        segmentId = null;
        segmentIdSpecified = false;
    }

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

    /**
     * @see SoftLayer_Brand_Business_Partner
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Brand_Business_Partner")
    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_Brand_Business_Partner::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Partner getObject();

        /**
         * Brand associated with the business partner data
         *
         * @see SoftLayer_Brand_Business_Partner::getBrand
         */
        @ApiMethod(instanceRequired = true)
        public Brand getBrand();

        /**
         * Channel indicator used to categorize business partner revenue.
         *
         * @see SoftLayer_Brand_Business_Partner::getChannel
         */
        @ApiMethod(instanceRequired = true)
        public Channel getChannel();

        /**
         * Segment indicator used to categorize business partner revenue.
         *
         * @see SoftLayer_Brand_Business_Partner::getSegment
         */
        @ApiMethod(instanceRequired = true)
        public Segment getSegment();

    }

    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#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.Brand.Mask brand() {
            return withSubMask("brand", com.softlayer.api.service.Brand.Mask.class);
        }

        public com.softlayer.api.service.business.partner.Channel.Mask channel() {
            return withSubMask("channel", com.softlayer.api.service.business.partner.Channel.Mask.class);
        }

        public com.softlayer.api.service.business.partner.Segment.Mask segment() {
            return withSubMask("segment", com.softlayer.api.service.business.partner.Segment.Mask.class);
        }

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

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

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

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

    }

}