ModifierGroup (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.inventory.ModifierGroup

All Implemented Interfaces:

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

Fields
See Also:

IInventoryService

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifierGroup.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`	`ModifierGroup.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<ModifierGroup> CREATOR

static JSONifiable.Creator<ModifierGroup> 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<ModifierGroup>`	`CREATOR`
`static JSONifiable.Creator<ModifierGroup>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ModifierGroup()` Constructs a new empty instance.
`protected`	`ModifierGroup(boolean noInit)` Constructs a new empty instance.
	`ModifierGroup(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.
	`ModifierGroup(ModifierGroup src)` Constructs a new instance that is a deep copy of the source instance.
	`ModifierGroup(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearAlternateName()` Clears the 'alternateName' field, the 'has' method for this field will now return false
`void`	`clearId()` Clears the 'id' field, the 'has' method for this field will now return false
`void`	`clearItems()` Clears the 'items' field, the 'has' method for this field will now return false
`void`	`clearMaxAllowed()` Clears the 'maxAllowed' field, the 'has' method for this field will now return false
`void`	`clearMenuModifierGroup()` Clears the 'menuModifierGroup' field, the 'has' method for this field will now return false
`void`	`clearMinRequired()` Clears the 'minRequired' field, the 'has' method for this field will now return false
`void`	`clearModifierIds()` Clears the 'modifierIds' field, the 'has' method for this field will now return false
`void`	`clearModifiers()` Clears the 'modifiers' field, the 'has' method for this field will now return false
`void`	`clearName()` Clears the 'name' field, the 'has' method for this field will now return false
`void`	`clearShowByDefault()` Clears the 'showByDefault' field, the 'has' method for this field will now return false
`void`	`clearSortOrder()` Clears the 'sortOrder' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`ModifierGroup`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`String`	`getAlternateName()`
`protected GenericClient`	`getGenericClient()`
`String`	`getId()` Unique identifier
`List<Reference>`	`getItems()`
`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.
`Integer`	`getMaxAllowed()` The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register
`MenuModifierGroup`	`getMenuModifierGroup()` Menu Modifier Group attribute that can be expanded to menu group specific attributes
`Integer`	`getMinRequired()` The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register
`String`	`getModifierIds()` An ordered, comma-separated list of modifier ids in this group.
`List<Modifier>`	`getModifiers()`
`String`	`getName()` Name of the modifier group
`Boolean`	`getShowByDefault()` Whether employees will be automatically prompted to add modifiers from this category when using Register
`Integer`	`getSortOrder()` The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.
`boolean`	`hasAlternateName()` Checks whether the 'alternateName' field has been set, however the value could be null
`boolean`	`hasId()` Checks whether the 'id' field has been set, however the value could be null
`boolean`	`hasItems()` Checks whether the 'items' field has been set, however the value could be null
`boolean`	`hasMaxAllowed()` Checks whether the 'maxAllowed' field has been set, however the value could be null
`boolean`	`hasMenuModifierGroup()` Checks whether the 'menuModifierGroup' field has been set, however the value could be null
`boolean`	`hasMinRequired()` Checks whether the 'minRequired' field has been set, however the value could be null
`boolean`	`hasModifierIds()` Checks whether the 'modifierIds' field has been set, however the value could be null
`boolean`	`hasModifiers()` Checks whether the 'modifiers' field has been set, however the value could be null
`boolean`	`hasName()` Checks whether the 'name' field has been set, however the value could be null
`boolean`	`hasShowByDefault()` Checks whether the 'showByDefault' field has been set, however the value could be null
`boolean`	`hasSortOrder()` Checks whether the 'sortOrder' field has been set, however the value could be null
`boolean`	`isNotEmptyItems()` Checks whether the 'items' field is set and is not null and is not empty
`boolean`	`isNotEmptyModifiers()` Checks whether the 'modifiers' field is set and is not null and is not empty
`boolean`	`isNotNullAlternateName()` Checks whether the 'alternateName' field is set and is not null
`boolean`	`isNotNullId()` Checks whether the 'id' field is set and is not null
`boolean`	`isNotNullItems()` Checks whether the 'items' field is set and is not null
`boolean`	`isNotNullMaxAllowed()` Checks whether the 'maxAllowed' field is set and is not null
`boolean`	`isNotNullMenuModifierGroup()` Checks whether the 'menuModifierGroup' field is set and is not null
`boolean`	`isNotNullMinRequired()` Checks whether the 'minRequired' field is set and is not null
`boolean`	`isNotNullModifierIds()` Checks whether the 'modifierIds' field is set and is not null
`boolean`	`isNotNullModifiers()` Checks whether the 'modifiers' field is set and is not null
`boolean`	`isNotNullName()` Checks whether the 'name' field is set and is not null
`boolean`	`isNotNullShowByDefault()` Checks whether the 'showByDefault' field is set and is not null
`boolean`	`isNotNullSortOrder()` Checks whether the 'sortOrder' field is set and is not null
`void`	`mergeChanges(ModifierGroup 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.
`ModifierGroup`	`setAlternateName(String alternateName)` Sets the field 'alternateName'.
`ModifierGroup`	`setId(String id)` Sets the field 'id'.
`ModifierGroup`	`setItems(List<Reference> items)` Sets the field 'items'.
`ModifierGroup`	`setMaxAllowed(Integer maxAllowed)` Sets the field 'maxAllowed'.
`ModifierGroup`	`setMenuModifierGroup(MenuModifierGroup menuModifierGroup)` Sets the field 'menuModifierGroup'.
`ModifierGroup`	`setMinRequired(Integer minRequired)` Sets the field 'minRequired'.
`ModifierGroup`	`setModifierIds(String modifierIds)` Sets the field 'modifierIds'.
`ModifierGroup`	`setModifiers(List<Modifier> modifiers)` Sets the field 'modifiers'.
`ModifierGroup`	`setName(String name)` Sets the field 'name'.
`ModifierGroup`	`setShowByDefault(Boolean showByDefault)` Sets the field 'showByDefault'.
`ModifierGroup`	`setSortOrder(Integer sortOrder)` Sets the field 'sortOrder'.
`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<ModifierGroup> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<ModifierGroup> JSON_CREATOR
```
- Constructor Detail
  - ModifierGroup
```
public ModifierGroup()
```
    Constructs a new empty instance.
  - ModifierGroup
```
protected ModifierGroup(boolean noInit)
```
    Constructs a new empty instance.
  - ModifierGroup
```
public ModifierGroup(String json)
              throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - ModifierGroup
```
public ModifierGroup(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.
  - ModifierGroup
```
public ModifierGroup(ModifierGroup src)
```
    Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
- Method Detail
  - getId
```
public String getId()
```
    Unique identifier
  - getName
```
public String getName()
```
    Name of the modifier group
  - getAlternateName
```
public String getAlternateName()
```
  - getMinRequired
```
public Integer getMinRequired()
```
    The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register
  - getMaxAllowed
```
public Integer getMaxAllowed()
```
    The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register
  - getShowByDefault
```
public Boolean getShowByDefault()
```
    Whether employees will be automatically prompted to add modifiers from this category when using Register
  - getModifiers
```
public List<Modifier> getModifiers()
```
  - getModifierIds
```
public String getModifierIds()
```
    An ordered, comma-separated list of modifier ids in this group. (READ ONLY)
  - getItems
```
public List<Reference> getItems()
```
  - getMenuModifierGroup
```
public MenuModifierGroup getMenuModifierGroup()
```
    Menu Modifier Group attribute that can be expanded to menu group specific attributes
  - getSortOrder
```
public Integer getSortOrder()
```
    The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.
  - 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
  - isNotNullId
```
public boolean isNotNullId()
```
    Checks whether the 'id' field is set and is not null
  - isNotNullName
```
public boolean isNotNullName()
```
    Checks whether the 'name' field is set and is not null
  - isNotNullAlternateName
```
public boolean isNotNullAlternateName()
```
    Checks whether the 'alternateName' field is set and is not null
  - isNotNullMinRequired
```
public boolean isNotNullMinRequired()
```
    Checks whether the 'minRequired' field is set and is not null
  - isNotNullMaxAllowed
```
public boolean isNotNullMaxAllowed()
```
    Checks whether the 'maxAllowed' field is set and is not null
  - isNotNullShowByDefault
```
public boolean isNotNullShowByDefault()
```
    Checks whether the 'showByDefault' field is set and is not null
  - isNotNullModifiers
```
public boolean isNotNullModifiers()
```
    Checks whether the 'modifiers' field is set and is not null
  - isNotEmptyModifiers
```
public boolean isNotEmptyModifiers()
```
    Checks whether the 'modifiers' field is set and is not null and is not empty
  - isNotNullModifierIds
```
public boolean isNotNullModifierIds()
```
    Checks whether the 'modifierIds' field is set and is not null
  - isNotNullItems
```
public boolean isNotNullItems()
```
    Checks whether the 'items' field is set and is not null
  - isNotEmptyItems
```
public boolean isNotEmptyItems()
```
    Checks whether the 'items' field is set and is not null and is not empty
  - isNotNullMenuModifierGroup
```
public boolean isNotNullMenuModifierGroup()
```
    Checks whether the 'menuModifierGroup' field is set and is not null
  - isNotNullSortOrder
```
public boolean isNotNullSortOrder()
```
    Checks whether the 'sortOrder' field is set and is not null
  - hasId
```
public boolean hasId()
```
    Checks whether the 'id' field has been set, however the value could be null
  - hasName
```
public boolean hasName()
```
    Checks whether the 'name' field has been set, however the value could be null
  - hasAlternateName
```
public boolean hasAlternateName()
```
    Checks whether the 'alternateName' field has been set, however the value could be null
  - hasMinRequired
```
public boolean hasMinRequired()
```
    Checks whether the 'minRequired' field has been set, however the value could be null
  - hasMaxAllowed
```
public boolean hasMaxAllowed()
```
    Checks whether the 'maxAllowed' field has been set, however the value could be null
  - hasShowByDefault
```
public boolean hasShowByDefault()
```
    Checks whether the 'showByDefault' field has been set, however the value could be null
  - hasModifiers
```
public boolean hasModifiers()
```
    Checks whether the 'modifiers' field has been set, however the value could be null
  - hasModifierIds
```
public boolean hasModifierIds()
```
    Checks whether the 'modifierIds' field has been set, however the value could be null
  - hasItems
```
public boolean hasItems()
```
    Checks whether the 'items' field has been set, however the value could be null
  - hasMenuModifierGroup
```
public boolean hasMenuModifierGroup()
```
    Checks whether the 'menuModifierGroup' field has been set, however the value could be null
  - hasSortOrder
```
public boolean hasSortOrder()
```
    Checks whether the 'sortOrder' field has been set, however the value could be null
  - setId
```
public ModifierGroup setId(String id)
```
    Sets the field 'id'.
  - setName
```
public ModifierGroup setName(String name)
```
    Sets the field 'name'.
  - setAlternateName
```
public ModifierGroup setAlternateName(String alternateName)
```
    Sets the field 'alternateName'.
  - setMinRequired
```
public ModifierGroup setMinRequired(Integer minRequired)
```
    Sets the field 'minRequired'.
  - setMaxAllowed
```
public ModifierGroup setMaxAllowed(Integer maxAllowed)
```
    Sets the field 'maxAllowed'.
  - setShowByDefault
```
public ModifierGroup setShowByDefault(Boolean showByDefault)
```
    Sets the field 'showByDefault'.
  - setModifiers
```
public ModifierGroup setModifiers(List<Modifier> modifiers)
```
    Sets the field 'modifiers'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setModifierIds
```
public ModifierGroup setModifierIds(String modifierIds)
```
    Sets the field 'modifierIds'.
  - setItems
```
public ModifierGroup setItems(List<Reference> items)
```
    Sets the field 'items'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setMenuModifierGroup
```
public ModifierGroup setMenuModifierGroup(MenuModifierGroup menuModifierGroup)
```
    Sets the field 'menuModifierGroup'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setSortOrder
```
public ModifierGroup setSortOrder(Integer sortOrder)
```
    Sets the field 'sortOrder'.
  - clearId
```
public void clearId()
```
    Clears the 'id' field, the 'has' method for this field will now return false
  - clearName
```
public void clearName()
```
    Clears the 'name' field, the 'has' method for this field will now return false
  - clearAlternateName
```
public void clearAlternateName()
```
    Clears the 'alternateName' field, the 'has' method for this field will now return false
  - clearMinRequired
```
public void clearMinRequired()
```
    Clears the 'minRequired' field, the 'has' method for this field will now return false
  - clearMaxAllowed
```
public void clearMaxAllowed()
```
    Clears the 'maxAllowed' field, the 'has' method for this field will now return false
  - clearShowByDefault
```
public void clearShowByDefault()
```
    Clears the 'showByDefault' field, the 'has' method for this field will now return false
  - clearModifiers
```
public void clearModifiers()
```
    Clears the 'modifiers' field, the 'has' method for this field will now return false
  - clearModifierIds
```
public void clearModifierIds()
```
    Clears the 'modifierIds' field, the 'has' method for this field will now return false
  - clearItems
```
public void clearItems()
```
    Clears the 'items' field, the 'has' method for this field will now return false
  - clearMenuModifierGroup
```
public void clearMenuModifierGroup()
```
    Clears the 'menuModifierGroup' field, the 'has' method for this field will now return false
  - clearSortOrder
```
public void clearSortOrder()
```
    Clears the 'sortOrder' 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 ModifierGroup copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(ModifierGroup src)
```
    Copy all the changed fields from the given source to this instance.

Class ModifierGroup

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

ModifierGroup

ModifierGroup

ModifierGroup

ModifierGroup

ModifierGroup

Method Detail

getId

getName

getAlternateName

getMinRequired

getMaxAllowed

getShowByDefault

getModifiers

getModifierIds

getItems

getMenuModifierGroup

getSortOrder

getGenericClient

getJSONObject

validate

isNotNullId

isNotNullName

isNotNullAlternateName

isNotNullMinRequired

isNotNullMaxAllowed

isNotNullShowByDefault

isNotNullModifiers

isNotEmptyModifiers

isNotNullModifierIds

isNotNullItems

isNotEmptyItems

isNotNullMenuModifierGroup

isNotNullSortOrder

hasId

hasName

hasAlternateName

hasMinRequired

hasMaxAllowed

hasShowByDefault

hasModifiers

hasModifierIds

hasItems

hasMenuModifierGroup

hasSortOrder

setId

setName

setAlternateName

setMinRequired

setMaxAllowed

setShowByDefault

setModifiers

setModifierIds

setItems

setMenuModifierGroup

setSortOrder

clearId

clearName

clearAlternateName

clearMinRequired

clearMaxAllowed

clearShowByDefault

clearModifiers

clearModifierIds

clearItems

clearMenuModifierGroup