com.softlayer.api.service.notification.user.subscriber.delivery.Method 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.user.subscriber.delivery;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.notification.user.Subscriber;

/**
 * Provides mapping details of how the subscriber's notification will be delivered.  This maps the subscriber's id with all the delivery method ids used to delivery the notification. 
 *
 * @see SoftLayer_Notification_User_Subscriber_Delivery_Method
 */
@ApiType("SoftLayer_Notification_User_Subscriber_Delivery_Method")
public class Method extends Entity {

    /**
     * Provides details for the method used to deliver the notification (email, sms, ticket).
     */
    @ApiProperty
    protected com.softlayer.api.service.notification.delivery.Method deliveryMethod;

    public com.softlayer.api.service.notification.delivery.Method getDeliveryMethod() {
        return deliveryMethod;
    }

    public void setDeliveryMethod(com.softlayer.api.service.notification.delivery.Method deliveryMethod) {
        this.deliveryMethod = deliveryMethod;
    }

    /**
     * The Subscriber information tied to the delivery method.
     */
    @ApiProperty
    protected Subscriber notificationUserSubscriber;

    public Subscriber getNotificationUserSubscriber() {
        return notificationUserSubscriber;
    }

    public void setNotificationUserSubscriber(Subscriber notificationUserSubscriber) {
        this.notificationUserSubscriber = notificationUserSubscriber;
    }

    /**
     * Determines if the delivery method is active for the user. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long active;

    public Long getActive() {
        return active;
    }

    public void setActive(Long active) {
        activeSpecified = true;
        this.active = active;
    }

    protected boolean activeSpecified;

    public boolean isActiveSpecified() {
        return activeSpecified;
    }

    public void unsetActive() {
        active = null;
        activeSpecified = false;
    }

    /**
     * Unique identifier of the method used to deliver notification. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long notificationMethodId;

    public Long getNotificationMethodId() {
        return notificationMethodId;
    }

    public void setNotificationMethodId(Long notificationMethodId) {
        notificationMethodIdSpecified = true;
        this.notificationMethodId = notificationMethodId;
    }

    protected boolean notificationMethodIdSpecified;

    public boolean isNotificationMethodIdSpecified() {
        return notificationMethodIdSpecified;
    }

    public void unsetNotificationMethodId() {
        notificationMethodId = null;
        notificationMethodIdSpecified = false;
    }

    /**
     * Unique identifier of the subscriber tied to the delivery method. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long notificationUserSubscriberId;

    public Long getNotificationUserSubscriberId() {
        return notificationUserSubscriberId;
    }

    public void setNotificationUserSubscriberId(Long notificationUserSubscriberId) {
        notificationUserSubscriberIdSpecified = true;
        this.notificationUserSubscriberId = notificationUserSubscriberId;
    }

    protected boolean notificationUserSubscriberIdSpecified;

    public boolean isNotificationUserSubscriberIdSpecified() {
        return notificationUserSubscriberIdSpecified;
    }

    public void unsetNotificationUserSubscriberId() {
        notificationUserSubscriberId = null;
        notificationUserSubscriberIdSpecified = false;
    }

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

        public com.softlayer.api.service.notification.delivery.Method.Mask deliveryMethod() {
            return withSubMask("deliveryMethod", com.softlayer.api.service.notification.delivery.Method.Mask.class);
        }

        public com.softlayer.api.service.notification.user.Subscriber.Mask notificationUserSubscriber() {
            return withSubMask("notificationUserSubscriber", com.softlayer.api.service.notification.user.Subscriber.Mask.class);
        }

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

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

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

    }

}