com.softlayer.api.service.notification.Preference 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.notification;

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

/**
 * Retrieve details for preferences.  Preferences are used to allow the subscriber to modify their subscription in various ways.  Details such as friendly name, keyname maximum and minimum values can be retrieved.  These provide details to help configure subscriber preferences correctly. 
 *
 * @see SoftLayer_Notification_Preference
 */
@ApiType("SoftLayer_Notification_Preference")
public class Preference extends Entity {

    /**
     * A description of what the preference is used for. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * Unique identifier for the notification preference. 
     */
    @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;
    }

    /**
     * Name that can be used by external systems to refer to preference. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String keyName;

    public String getKeyName() {
        return keyName;
    }

    public void setKeyName(String keyName) {
        keyNameSpecified = true;
        this.keyName = keyName;
    }

    protected boolean keyNameSpecified;

    public boolean isKeyNameSpecified() {
        return keyNameSpecified;
    }

    public void unsetKeyName() {
        keyName = null;
        keyNameSpecified = false;
    }

    /**
     * Largest value allowed for the preference. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String maximumValue;

    public String getMaximumValue() {
        return maximumValue;
    }

    public void setMaximumValue(String maximumValue) {
        maximumValueSpecified = true;
        this.maximumValue = maximumValue;
    }

    protected boolean maximumValueSpecified;

    public boolean isMaximumValueSpecified() {
        return maximumValueSpecified;
    }

    public void unsetMaximumValue() {
        maximumValue = null;
        maximumValueSpecified = false;
    }

    /**
     * Smallest value allowed for the preference. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String minimumValue;

    public String getMinimumValue() {
        return minimumValue;
    }

    public void setMinimumValue(String minimumValue) {
        minimumValueSpecified = true;
        this.minimumValue = minimumValue;
    }

    protected boolean minimumValueSpecified;

    public boolean isMinimumValueSpecified() {
        return minimumValueSpecified;
    }

    public void unsetMinimumValue() {
        minimumValue = null;
        minimumValueSpecified = false;
    }

    /**
     * Friendly name for the notification. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

    /**
     * The unit of measure used for the preference's value, minimum and maximum as well. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String units;

    public String getUnits() {
        return units;
    }

    public void setUnits(String units) {
        unitsSpecified = true;
        this.units = units;
    }

    protected boolean unitsSpecified;

    public boolean isUnitsSpecified() {
        return unitsSpecified;
    }

    public void unsetUnits() {
        units = null;
        unitsSpecified = false;
    }

    /**
     * Default value used when setting up preferences for a new subscriber. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        valueSpecified = true;
        this.value = value;
    }

    protected boolean valueSpecified;

    public boolean isValueSpecified() {
        return valueSpecified;
    }

    public void unsetValue() {
        value = null;
        valueSpecified = false;
    }

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

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

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

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

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

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

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

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

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

    }

}