MerchantPlanRules (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.merchant.MerchantPlanRules

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class MerchantPlanRules
extends GenericParcelable
implements Validator, JSONifiable
```
This is an auto-generated Clover data object.

Fields

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MerchantPlanRules.Constraints
- Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
  JSONifiable.Creator<T>
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MerchantPlanRules.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<MerchantPlanRules> CREATOR

static JSONifiable.Creator<MerchantPlanRules> JSON_CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<MerchantPlanRules>`	`CREATOR`
`static JSONifiable.Creator<MerchantPlanRules>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MerchantPlanRules()` Constructs a new empty instance.
`protected`	`MerchantPlanRules(boolean noInit)` Constructs a new empty instance.
	`MerchantPlanRules(JSONObject jsonObject)` Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
	`MerchantPlanRules(MerchantPlanRules src)` Constructs a new instance that is a deep copy of the source instance.
	`MerchantPlanRules(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearDisplayDetailedPlanSelectionDescription()` Clears the 'displayDetailedPlanSelectionDescription' field, the 'has' method for this field will now return false
`void`	`clearDisplayPlanRestrictionAlert()` Clears the 'displayPlanRestrictionAlert' field, the 'has' method for this field will now return false
`void`	`clearDisplayRecommendedPlanOnServicePlansPage()` Clears the 'displayRecommendedPlanOnServicePlansPage' field, the 'has' method for this field will now return false
`void`	`clearEnforceAdditionalAppsAuthorization()` Clears the 'enforceAdditionalAppsAuthorization' field, the 'has' method for this field will now return false
`void`	`clearEnforceChoosePlan()` Clears the 'enforceChoosePlan' field, the 'has' method for this field will now return false
`void`	`clearEnforcePlanAuthorization()` Clears the 'enforcePlanAuthorization' field, the 'has' method for this field will now return false
`void`	`clearHighlightModel()` Clears the 'highlightModel' field, the 'has' method for this field will now return false
`void`	`clearNotifyPlanRestrictionAlert()` Clears the 'notifyPlanRestrictionAlert' field, the 'has' method for this field will now return false
`void`	`clearTosBillingModel()` Clears the 'tosBillingModel' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`MerchantPlanRules`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`Boolean`	`getDisplayDetailedPlanSelectionDescription()` Flag for OOBE and Service Plans page whether or not to show detailed plan pricing information for the plan selection screen
`Boolean`	`getDisplayPlanRestrictionAlert()` Flag for OOBE whether or not to show special language about a force plan change based on device restrictions.
`Boolean`	`getDisplayRecommendedPlanOnServicePlansPage()` Deprecated.
`EnforceAdditionalAppsAuthorization`	`getEnforceAdditionalAppsAuthorization()` Flag for OOBE whether or not to show apps authorization.
`Boolean`	`getEnforceChoosePlan()` Deprecated.
`EnforcePlanAuthorization`	`getEnforcePlanAuthorization()` Flag for OOBE whether or not to enforce plan authorization and how often.
`protected GenericClient`	`getGenericClient()`
`Map<String,String>`	`getHighlightModel()` keys/values specific to this endpoint/type
`JSONObject`	`getJSONObject()` Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.
`Boolean`	`getNotifyPlanRestrictionAlert()` Flag to control if notifications (like emails) are sent when a force plan change happens based on device restrictions.
`String`	`getTosBillingModel()`
`boolean`	`hasDisplayDetailedPlanSelectionDescription()` Checks whether the 'displayDetailedPlanSelectionDescription' field has been set, however the value could be null
`boolean`	`hasDisplayPlanRestrictionAlert()` Checks whether the 'displayPlanRestrictionAlert' field has been set, however the value could be null
`boolean`	`hasDisplayRecommendedPlanOnServicePlansPage()` Checks whether the 'displayRecommendedPlanOnServicePlansPage' field has been set, however the value could be null
`boolean`	`hasEnforceAdditionalAppsAuthorization()` Checks whether the 'enforceAdditionalAppsAuthorization' field has been set, however the value could be null
`boolean`	`hasEnforceChoosePlan()` Checks whether the 'enforceChoosePlan' field has been set, however the value could be null
`boolean`	`hasEnforcePlanAuthorization()` Checks whether the 'enforcePlanAuthorization' field has been set, however the value could be null
`boolean`	`hasHighlightModel()` Checks whether the 'highlightModel' field has been set, however the value could be null
`boolean`	`hasNotifyPlanRestrictionAlert()` Checks whether the 'notifyPlanRestrictionAlert' field has been set, however the value could be null
`boolean`	`hasTosBillingModel()` Checks whether the 'tosBillingModel' field has been set, however the value could be null
`boolean`	`isNotEmptyHighlightModel()` Checks whether the 'highlightModel' field is set and is not null and is not empty
`boolean`	`isNotNullDisplayDetailedPlanSelectionDescription()` Checks whether the 'displayDetailedPlanSelectionDescription' field is set and is not null
`boolean`	`isNotNullDisplayPlanRestrictionAlert()` Checks whether the 'displayPlanRestrictionAlert' field is set and is not null
`boolean`	`isNotNullDisplayRecommendedPlanOnServicePlansPage()` Checks whether the 'displayRecommendedPlanOnServicePlansPage' field is set and is not null
`boolean`	`isNotNullEnforceAdditionalAppsAuthorization()` Checks whether the 'enforceAdditionalAppsAuthorization' field is set and is not null
`boolean`	`isNotNullEnforceChoosePlan()` Checks whether the 'enforceChoosePlan' field is set and is not null
`boolean`	`isNotNullEnforcePlanAuthorization()` Checks whether the 'enforcePlanAuthorization' field is set and is not null
`boolean`	`isNotNullHighlightModel()` Checks whether the 'highlightModel' field is set and is not null
`boolean`	`isNotNullNotifyPlanRestrictionAlert()` Checks whether the 'notifyPlanRestrictionAlert' field is set and is not null
`boolean`	`isNotNullTosBillingModel()` Checks whether the 'tosBillingModel' field is set and is not null
`void`	`mergeChanges(MerchantPlanRules src)` Copy all the changed fields from the given source to this instance.
`void`	`resetChangeLog()` Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
`MerchantPlanRules`	`setDisplayDetailedPlanSelectionDescription(Boolean displayDetailedPlanSelectionDescription)` Sets the field 'displayDetailedPlanSelectionDescription'.
`MerchantPlanRules`	`setDisplayPlanRestrictionAlert(Boolean displayPlanRestrictionAlert)` Sets the field 'displayPlanRestrictionAlert'.
`MerchantPlanRules`	`setDisplayRecommendedPlanOnServicePlansPage(Boolean displayRecommendedPlanOnServicePlansPage)` Sets the field 'displayRecommendedPlanOnServicePlansPage'.
`MerchantPlanRules`	`setEnforceAdditionalAppsAuthorization(EnforceAdditionalAppsAuthorization enforceAdditionalAppsAuthorization)` Sets the field 'enforceAdditionalAppsAuthorization'.
`MerchantPlanRules`	`setEnforceChoosePlan(Boolean enforceChoosePlan)` Sets the field 'enforceChoosePlan'.
`MerchantPlanRules`	`setEnforcePlanAuthorization(EnforcePlanAuthorization enforcePlanAuthorization)` Sets the field 'enforcePlanAuthorization'.
`MerchantPlanRules`	`setHighlightModel(Map<String,String> highlightModel)` Sets the field 'highlightModel'.
`MerchantPlanRules`	`setNotifyPlanRestrictionAlert(Boolean notifyPlanRestrictionAlert)` Sets the field 'notifyPlanRestrictionAlert'.
`MerchantPlanRules`	`setTosBillingModel(String tosBillingModel)` Sets the field 'tosBillingModel'.
`void`	`validate()`

Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final Parcelable.Creator<MerchantPlanRules> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<MerchantPlanRules> JSON_CREATOR
```
- Constructor Detail
  - MerchantPlanRules
```
public MerchantPlanRules()
```
    Constructs a new empty instance.
  - MerchantPlanRules
```
protected MerchantPlanRules(boolean noInit)
```
    Constructs a new empty instance.
  - MerchantPlanRules
```
public MerchantPlanRules(String json)
                  throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - MerchantPlanRules
```
public MerchantPlanRules(JSONObject jsonObject)
```
    Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - MerchantPlanRules
```
public MerchantPlanRules(MerchantPlanRules src)
```
    Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
- Method Detail
  - getEnforcePlanAuthorization
```
public EnforcePlanAuthorization getEnforcePlanAuthorization()
```
    Flag for OOBE whether or not to enforce plan authorization and how often.
  - getEnforceAdditionalAppsAuthorization
```
public EnforceAdditionalAppsAuthorization getEnforceAdditionalAppsAuthorization()
```
    Flag for OOBE whether or not to show apps authorization.
  - getDisplayPlanRestrictionAlert
```
public Boolean getDisplayPlanRestrictionAlert()
```
    Flag for OOBE whether or not to show special language about a force plan change based on device restrictions.
  - getNotifyPlanRestrictionAlert
```
public Boolean getNotifyPlanRestrictionAlert()
```
    Flag to control if notifications (like emails) are sent when a force plan change happens based on device restrictions.
  - getDisplayDetailedPlanSelectionDescription
```
public Boolean getDisplayDetailedPlanSelectionDescription()
```
    Flag for OOBE and Service Plans page whether or not to show detailed plan pricing information for the plan selection screen
  - getHighlightModel
```
public Map<String,String> getHighlightModel()
```
    keys/values specific to this endpoint/type
  - getTosBillingModel
```
public String getTosBillingModel()
```
  - getDisplayRecommendedPlanOnServicePlansPage
```
@Deprecated
public Boolean getDisplayRecommendedPlanOnServicePlansPage()
```
    Deprecated.
    
    Deprecated but must keep for few app OOBE cycles.
  - getEnforceChoosePlan
```
@Deprecated
public Boolean getEnforceChoosePlan()
```
    Deprecated.
    
    Deprecated but must keep for few app OOBE cycles.
  - getGenericClient
```
protected GenericClient getGenericClient()
```
    Specified by:
    
    getGenericClient in class GenericParcelable
  - getJSONObject
```
public JSONObject getJSONObject()
```
    Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.
    
    Specified by:
    
    getJSONObject in interface JSONifiable
  - validate
```
public void validate()
```
    Specified by:
    
    validate in interface Validator
  - isNotNullEnforcePlanAuthorization
```
public boolean isNotNullEnforcePlanAuthorization()
```
    Checks whether the 'enforcePlanAuthorization' field is set and is not null
  - isNotNullEnforceAdditionalAppsAuthorization
```
public boolean isNotNullEnforceAdditionalAppsAuthorization()
```
    Checks whether the 'enforceAdditionalAppsAuthorization' field is set and is not null
  - isNotNullDisplayPlanRestrictionAlert
```
public boolean isNotNullDisplayPlanRestrictionAlert()
```
    Checks whether the 'displayPlanRestrictionAlert' field is set and is not null
  - isNotNullNotifyPlanRestrictionAlert
```
public boolean isNotNullNotifyPlanRestrictionAlert()
```
    Checks whether the 'notifyPlanRestrictionAlert' field is set and is not null
  - isNotNullDisplayDetailedPlanSelectionDescription
```
public boolean isNotNullDisplayDetailedPlanSelectionDescription()
```
    Checks whether the 'displayDetailedPlanSelectionDescription' field is set and is not null
  - isNotNullHighlightModel
```
public boolean isNotNullHighlightModel()
```
    Checks whether the 'highlightModel' field is set and is not null
  - isNotEmptyHighlightModel
```
public boolean isNotEmptyHighlightModel()
```
    Checks whether the 'highlightModel' field is set and is not null and is not empty
  - isNotNullTosBillingModel
```
public boolean isNotNullTosBillingModel()
```
    Checks whether the 'tosBillingModel' field is set and is not null
  - isNotNullDisplayRecommendedPlanOnServicePlansPage
```
public boolean isNotNullDisplayRecommendedPlanOnServicePlansPage()
```
    Checks whether the 'displayRecommendedPlanOnServicePlansPage' field is set and is not null
  - isNotNullEnforceChoosePlan
```
public boolean isNotNullEnforceChoosePlan()
```
    Checks whether the 'enforceChoosePlan' field is set and is not null
  - hasEnforcePlanAuthorization
```
public boolean hasEnforcePlanAuthorization()
```
    Checks whether the 'enforcePlanAuthorization' field has been set, however the value could be null
  - hasEnforceAdditionalAppsAuthorization
```
public boolean hasEnforceAdditionalAppsAuthorization()
```
    Checks whether the 'enforceAdditionalAppsAuthorization' field has been set, however the value could be null
  - hasDisplayPlanRestrictionAlert
```
public boolean hasDisplayPlanRestrictionAlert()
```
    Checks whether the 'displayPlanRestrictionAlert' field has been set, however the value could be null
  - hasNotifyPlanRestrictionAlert
```
public boolean hasNotifyPlanRestrictionAlert()
```
    Checks whether the 'notifyPlanRestrictionAlert' field has been set, however the value could be null
  - hasDisplayDetailedPlanSelectionDescription
```
public boolean hasDisplayDetailedPlanSelectionDescription()
```
    Checks whether the 'displayDetailedPlanSelectionDescription' field has been set, however the value could be null
  - hasHighlightModel
```
public boolean hasHighlightModel()
```
    Checks whether the 'highlightModel' field has been set, however the value could be null
  - hasTosBillingModel
```
public boolean hasTosBillingModel()
```
    Checks whether the 'tosBillingModel' field has been set, however the value could be null
  - hasDisplayRecommendedPlanOnServicePlansPage
```
public boolean hasDisplayRecommendedPlanOnServicePlansPage()
```
    Checks whether the 'displayRecommendedPlanOnServicePlansPage' field has been set, however the value could be null
  - hasEnforceChoosePlan
```
public boolean hasEnforceChoosePlan()
```
    Checks whether the 'enforceChoosePlan' field has been set, however the value could be null
  - setEnforcePlanAuthorization
```
public MerchantPlanRules setEnforcePlanAuthorization(EnforcePlanAuthorization enforcePlanAuthorization)
```
    Sets the field 'enforcePlanAuthorization'.
  - setEnforceAdditionalAppsAuthorization
```
public MerchantPlanRules setEnforceAdditionalAppsAuthorization(EnforceAdditionalAppsAuthorization enforceAdditionalAppsAuthorization)
```
    Sets the field 'enforceAdditionalAppsAuthorization'.
  - setDisplayPlanRestrictionAlert
```
public MerchantPlanRules setDisplayPlanRestrictionAlert(Boolean displayPlanRestrictionAlert)
```
    Sets the field 'displayPlanRestrictionAlert'.
  - setNotifyPlanRestrictionAlert
```
public MerchantPlanRules setNotifyPlanRestrictionAlert(Boolean notifyPlanRestrictionAlert)
```
    Sets the field 'notifyPlanRestrictionAlert'.
  - setDisplayDetailedPlanSelectionDescription
```
public MerchantPlanRules setDisplayDetailedPlanSelectionDescription(Boolean displayDetailedPlanSelectionDescription)
```
    Sets the field 'displayDetailedPlanSelectionDescription'.
  - setHighlightModel
```
public MerchantPlanRules setHighlightModel(Map<String,String> highlightModel)
```
    Sets the field 'highlightModel'.
  - setTosBillingModel
```
public MerchantPlanRules setTosBillingModel(String tosBillingModel)
```
    Sets the field 'tosBillingModel'.
  - setDisplayRecommendedPlanOnServicePlansPage
```
public MerchantPlanRules setDisplayRecommendedPlanOnServicePlansPage(Boolean displayRecommendedPlanOnServicePlansPage)
```
    Sets the field 'displayRecommendedPlanOnServicePlansPage'.
  - setEnforceChoosePlan
```
public MerchantPlanRules setEnforceChoosePlan(Boolean enforceChoosePlan)
```
    Sets the field 'enforceChoosePlan'.
  - clearEnforcePlanAuthorization
```
public void clearEnforcePlanAuthorization()
```
    Clears the 'enforcePlanAuthorization' field, the 'has' method for this field will now return false
  - clearEnforceAdditionalAppsAuthorization
```
public void clearEnforceAdditionalAppsAuthorization()
```
    Clears the 'enforceAdditionalAppsAuthorization' field, the 'has' method for this field will now return false
  - clearDisplayPlanRestrictionAlert
```
public void clearDisplayPlanRestrictionAlert()
```
    Clears the 'displayPlanRestrictionAlert' field, the 'has' method for this field will now return false
  - clearNotifyPlanRestrictionAlert
```
public void clearNotifyPlanRestrictionAlert()
```
    Clears the 'notifyPlanRestrictionAlert' field, the 'has' method for this field will now return false
  - clearDisplayDetailedPlanSelectionDescription
```
public void clearDisplayDetailedPlanSelectionDescription()
```
    Clears the 'displayDetailedPlanSelectionDescription' field, the 'has' method for this field will now return false
  - clearHighlightModel
```
public void clearHighlightModel()
```
    Clears the 'highlightModel' field, the 'has' method for this field will now return false
  - clearTosBillingModel
```
public void clearTosBillingModel()
```
    Clears the 'tosBillingModel' field, the 'has' method for this field will now return false
  - clearDisplayRecommendedPlanOnServicePlansPage
```
public void clearDisplayRecommendedPlanOnServicePlansPage()
```
    Clears the 'displayRecommendedPlanOnServicePlansPage' field, the 'has' method for this field will now return false
  - clearEnforceChoosePlan
```
public void clearEnforceChoosePlan()
```
    Clears the 'enforceChoosePlan' field, the 'has' method for this field will now return false
  - containsChanges
```
public boolean containsChanges()
```
    Returns true if this instance has any changes.
  - resetChangeLog
```
public void resetChangeLog()
```
    Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
  - copyChanges
```
public MerchantPlanRules copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(MerchantPlanRules src)
```
    Copy all the changed fields from the given source to this instance.

Class MerchantPlanRules

Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.clover.sdk.GenericParcelable

Methods inherited from class java.lang.Object

Field Detail

CREATOR

JSON_CREATOR

Constructor Detail

MerchantPlanRules

MerchantPlanRules

MerchantPlanRules

MerchantPlanRules

MerchantPlanRules

Method Detail

getEnforcePlanAuthorization

getEnforceAdditionalAppsAuthorization

getDisplayPlanRestrictionAlert

getNotifyPlanRestrictionAlert

getDisplayDetailedPlanSelectionDescription

getHighlightModel

getTosBillingModel

getDisplayRecommendedPlanOnServicePlansPage

getEnforceChoosePlan

getGenericClient

getJSONObject

validate

isNotNullEnforcePlanAuthorization

isNotNullEnforceAdditionalAppsAuthorization

isNotNullDisplayPlanRestrictionAlert

isNotNullNotifyPlanRestrictionAlert

isNotNullDisplayDetailedPlanSelectionDescription

isNotNullHighlightModel

isNotEmptyHighlightModel

isNotNullTosBillingModel

isNotNullDisplayRecommendedPlanOnServicePlansPage

isNotNullEnforceChoosePlan

hasEnforcePlanAuthorization

hasEnforceAdditionalAppsAuthorization

hasDisplayPlanRestrictionAlert

hasNotifyPlanRestrictionAlert

hasDisplayDetailedPlanSelectionDescription

hasHighlightModel

hasTosBillingModel

hasDisplayRecommendedPlanOnServicePlansPage

hasEnforceChoosePlan

setEnforcePlanAuthorization

setEnforceAdditionalAppsAuthorization

setDisplayPlanRestrictionAlert

setNotifyPlanRestrictionAlert

setDisplayDetailedPlanSelectionDescription

setHighlightModel

setTosBillingModel

setDisplayRecommendedPlanOnServicePlansPage

setEnforceChoosePlan

clearEnforcePlanAuthorization

clearEnforceAdditionalAppsAuthorization

clearDisplayPlanRestrictionAlert

clearNotifyPlanRestrictionAlert

clearDisplayDetailedPlanSelectionDescription

clearHighlightModel

clearTosBillingModel

clearDisplayRecommendedPlanOnServicePlansPage

clearEnforceChoosePlan

containsChanges

resetChangeLog

copyChanges

mergeChanges