com.softlayer.api.service.container.user.data.Phone 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.container.user.data;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;

/**
 * This container holds user's phone information. 
 *
 * @see SoftLayer_Container_User_Data_Phone
 */
@ApiType("SoftLayer_Container_User_Data_Phone")
public class Phone extends Entity {

    /**
     * Country code number for the phone number Default: 1 (United States & Canada +1) 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long countryCode;

    public Long getCountryCode() {
        return countryCode;
    }

    public void setCountryCode(Long countryCode) {
        countryCodeSpecified = true;
        this.countryCode = countryCode;
    }

    protected boolean countryCodeSpecified;

    public boolean isCountryCodeSpecified() {
        return countryCodeSpecified;
    }

    public void unsetCountryCode() {
        countryCode = null;
        countryCodeSpecified = false;
    }

    /**
     * Phone extension code. It can be digits, commas, *, and # are allowed. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String extension;

    public String getExtension() {
        return extension;
    }

    public void setExtension(String extension) {
        extensionSpecified = true;
        this.extension = extension;
    }

    protected boolean extensionSpecified;

    public boolean isExtensionSpecified() {
        return extensionSpecified;
    }

    public void unsetExtension() {
        extension = null;
        extensionSpecified = false;
    }

    /**
     * Phone number can be a mobile phone number, desk phone number, or some other option. The phone number format must match the format selected in the country code. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String phone;

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        phoneSpecified = true;
        this.phone = phone;
    }

    protected boolean phoneSpecified;

    public boolean isPhoneSpecified() {
        return phoneSpecified;
    }

    public void unsetPhone() {
        phone = null;
        phoneSpecified = false;
    }

    /**
     * Type of phone number such as "primary", "office" or "home" 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String phoneType;

    public String getPhoneType() {
        return phoneType;
    }

    public void setPhoneType(String phoneType) {
        phoneTypeSpecified = true;
        this.phoneType = phoneType;
    }

    protected boolean phoneTypeSpecified;

    public boolean isPhoneTypeSpecified() {
        return phoneTypeSpecified;
    }

    public void unsetPhoneType() {
        phoneType = null;
        phoneTypeSpecified = false;
    }

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

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

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

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

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

    }

}