Package com.softlayer.api.service.notification.user.subscriber

Class Preference

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.notification.user.subscriber.Preference

@ApiType("SoftLayer_Notification_User_Subscriber_Preference")
public class Preference
extends Entity

Preferences are settings that can be modified to change the behavior of the subscription. For example, modify the limit preference to only receive notifications 10 times instead of 1 during a billing cycle.

NOTE: Some preferences have certain restrictions on values that can be set.

See Also:

SoftLayer_Notification_User_Subscriber_Preference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Preference.Mask
static interface	Preference.Service
static interface	Preference.ServiceAsync

Field Summary

Fields

Modifier and Type	Field	Description
protected Preference	defaultPreference	Details such name, keyname, minimum and maximum values for the preference.
protected Long	id	Unique identifier for the subscriber's preferences.
protected boolean	idSpecified
protected Long	notificationPreferenceId	Unique identifier of the default preference for which the subscriber preference is based on.
protected boolean	notificationPreferenceIdSpecified
protected Subscriber	notificationUserSubscriber	Details of the subscriber tied to the preference.
protected Long	notificationUserSubscriberId	Unique identifier of the subscriber tied to the subscriber preference.
protected boolean	notificationUserSubscriberIdSpecified
protected String	value	The user supplied value to "override" the "default" preference's value.
protected boolean	valueSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Preference()

Method Summary

Modifier and Type	Method	Description
Preference.Service	asService(ApiClient client)
Preference	getDefaultPreference()
Long	getId()
Long	getNotificationPreferenceId()
Subscriber	getNotificationUserSubscriber()
Long	getNotificationUserSubscriberId()
String	getValue()
boolean	isIdSpecified()
boolean	isNotificationPreferenceIdSpecified()
boolean	isNotificationUserSubscriberIdSpecified()
boolean	isValueSpecified()
static Preference.Service	service(ApiClient client)
static Preference.Service	service(ApiClient client, Long id)
void	setDefaultPreference(Preference defaultPreference)
void	setId(Long id)
void	setNotificationPreferenceId(Long notificationPreferenceId)
void	setNotificationUserSubscriber(Subscriber notificationUserSubscriber)
void	setNotificationUserSubscriberId(Long notificationUserSubscriberId)
void	setValue(String value)
void	unsetId()
void	unsetNotificationPreferenceId()
void	unsetNotificationUserSubscriberId()
void	unsetValue()

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultPreference

@ApiProperty
protected Preference defaultPreference

Details such name, keyname, minimum and maximum values for the preference.

notificationUserSubscriber

@ApiProperty
protected Subscriber notificationUserSubscriber

Details of the subscriber tied to the preference.

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

Unique identifier for the subscriber's preferences.

idSpecified

protected boolean idSpecified

notificationPreferenceId

@ApiProperty(canBeNullOrNotSet=true)
protected Long notificationPreferenceId

Unique identifier of the default preference for which the subscriber preference is based on. For example, if no preferences are supplied during the creation of a subscriber. The default values are pulled using this property.

notificationPreferenceIdSpecified

protected boolean notificationPreferenceIdSpecified

notificationUserSubscriberId

@ApiProperty(canBeNullOrNotSet=true)
protected Long notificationUserSubscriberId

Unique identifier of the subscriber tied to the subscriber preference.

notificationUserSubscriberIdSpecified

protected boolean notificationUserSubscriberIdSpecified

value

@ApiProperty(canBeNullOrNotSet=true)
protected String value

The user supplied value to "override" the "default" preference's value.

valueSpecified

protected boolean valueSpecified

Constructor Detail

Preference

public Preference()

Method Detail

getDefaultPreference

public Preference getDefaultPreference()

setDefaultPreference

public void setDefaultPreference(Preference defaultPreference)

getNotificationUserSubscriber

public Subscriber getNotificationUserSubscriber()

setNotificationUserSubscriber

public void setNotificationUserSubscriber(Subscriber notificationUserSubscriber)

getId

public Long getId()

setId

public void setId(Long id)

isIdSpecified

public boolean isIdSpecified()

unsetId

public void unsetId()

getNotificationPreferenceId

public Long getNotificationPreferenceId()

setNotificationPreferenceId

public void setNotificationPreferenceId(Long notificationPreferenceId)

isNotificationPreferenceIdSpecified

public boolean isNotificationPreferenceIdSpecified()

unsetNotificationPreferenceId

public void unsetNotificationPreferenceId()

getNotificationUserSubscriberId

public Long getNotificationUserSubscriberId()

setNotificationUserSubscriberId

public void setNotificationUserSubscriberId(Long notificationUserSubscriberId)

isNotificationUserSubscriberIdSpecified

public boolean isNotificationUserSubscriberIdSpecified()

unsetNotificationUserSubscriberId

public void unsetNotificationUserSubscriberId()

getValue

public String getValue()

setValue

public void setValue(String value)

isValueSpecified

public boolean isValueSpecified()

unsetValue

public void unsetValue()

asService

public Preference.Service asService(ApiClient client)

service

public static Preference.Service service(ApiClient client)

service

public static Preference.Service service(ApiClient client,
                                         Long id)