OrderLineItemModifier (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.OrderLineItemModifier

```
public class OrderLineItemModifier
extends Object
```
This is a model class for OrderLineItemModifier type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OrderLineItemModifier.Builder
Class to build instances of OrderLineItemModifier.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrderLineItemModifier.Builder` Class to build instances of `OrderLineItemModifier`.

Constructor Summary

Constructors
Constructor and Description
`OrderLineItemModifier(String uid, String catalogObjectId, Long catalogVersion, String name, String quantity, Money basePriceMoney, Money totalPriceMoney, Map<String,String> metadata)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Money`	`getBasePriceMoney()` Getter for BasePriceMoney.
`String`	`getCatalogObjectId()` Getter for CatalogObjectId.
`Long`	`getCatalogVersion()` Getter for CatalogVersion.
`Map<String,String>`	`getMetadata()` Getter for Metadata.
`String`	`getName()` Getter for Name.
`String`	`getQuantity()` Getter for Quantity.
`Money`	`getTotalPriceMoney()` Getter for TotalPriceMoney.
`String`	`getUid()` Getter for Uid.
`int`	`hashCode()`
`OrderLineItemModifier.Builder`	`toBuilder()` Builds a new `OrderLineItemModifier.Builder` object.
`String`	`toString()` Converts this OrderLineItemModifier into string format.

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

- Constructor Detail
  - OrderLineItemModifier
```
public OrderLineItemModifier(String uid,
                             String catalogObjectId,
                             Long catalogVersion,
                             String name,
                             String quantity,
                             Money basePriceMoney,
                             Money totalPriceMoney,
                             Map<String,String> metadata)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    catalogObjectId - String value for catalogObjectId.
    
    catalogVersion - Long value for catalogVersion.
    
    name - String value for name.
    
    quantity - String value for quantity.
    
    basePriceMoney - Money value for basePriceMoney.
    
    totalPriceMoney - Money value for totalPriceMoney.
    
    metadata - Map of String, value for metadata.
- Method Detail
  - getUid
```
public String getUid()
```
    Getter for Uid. A unique ID that identifies the modifier only within this order.
    
    Returns:
    
    Returns the String
  - getCatalogObjectId
```
public String getCatalogObjectId()
```
    Getter for CatalogObjectId. The catalog object ID referencing [CatalogModifier]($m/CatalogModifier).
    
    Returns:
    
    Returns the String
  - getCatalogVersion
```
public Long getCatalogVersion()
```
    Getter for CatalogVersion. The version of the catalog object that this modifier references.
    
    Returns:
    
    Returns the Long
  - getName
```
public String getName()
```
    Getter for Name. The name of the item modifier.
    
    Returns:
    
    Returns the String
  - getQuantity
```
public String getQuantity()
```
    Getter for Quantity. The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an `Order` object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.
    
    Returns:
    
    Returns the String
  - getBasePriceMoney
```
public Money getBasePriceMoney()
```
    Getter for BasePriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalPriceMoney
```
public Money getTotalPriceMoney()
```
    Getter for TotalPriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Getter for Metadata. Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
    
    Returns:
    
    Returns the Map of String, String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this OrderLineItemModifier into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public OrderLineItemModifier.Builder toBuilder()
```
    Builds a new OrderLineItemModifier.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new OrderLineItemModifier.Builder object

Class OrderLineItemModifier

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderLineItemModifier

Method Detail

getUid

getCatalogObjectId

getCatalogVersion

getName

getQuantity

getBasePriceMoney

getTotalPriceMoney

getMetadata

hashCode

equals

toString

toBuilder