com.squareup.square.models

Class CashDrawerShiftSummary

java.lang.Object

com.squareup.square.models.CashDrawerShiftSummary

public class CashDrawerShiftSummary
extends Object

This is a model class for CashDrawerShiftSummary type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CashDrawerShiftSummary.Builder Class to build instances of CashDrawerShiftSummary.

Constructor Summary

Constructors

Constructor and Description
CashDrawerShiftSummary(String id, String state, String openedAt, String endedAt, String closedAt, String description, Money openedCashMoney, Money expectedCashMoney, Money closedCashMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClosedAt() Getter for ClosedAt.
Money	getClosedCashMoney() Getter for ClosedCashMoney.
String	getDescription() Getter for Description.
String	getEndedAt() Getter for EndedAt.
Money	getExpectedCashMoney() Getter for ExpectedCashMoney.
String	getId() Getter for Id.
String	getOpenedAt() Getter for OpenedAt.
Money	getOpenedCashMoney() Getter for OpenedCashMoney.
String	getState() Getter for State.
int	hashCode()
CashDrawerShiftSummary.Builder	toBuilder() Builds a new CashDrawerShiftSummary.Builder object.
String	toString() Converts this CashDrawerShiftSummary into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CashDrawerShiftSummary

public CashDrawerShiftSummary(String id,
                              String state,
                              String openedAt,
                              String endedAt,
                              String closedAt,
                              String description,
                              Money openedCashMoney,
                              Money expectedCashMoney,
                              Money closedCashMoney)

Initialization constructor.

Parameters:

id - String value for id.

state - String value for state.

openedAt - String value for openedAt.

endedAt - String value for endedAt.

closedAt - String value for closedAt.

description - String value for description.

openedCashMoney - Money value for openedCashMoney.

expectedCashMoney - Money value for expectedCashMoney.

closedCashMoney - Money value for closedCashMoney.

Method Detail

getId

public String getId()

Getter for Id. The shift unique ID.

Returns:

Returns the String

getState

public String getState()

Getter for State. The current state of a cash drawer shift.

Returns:

Returns the String

getOpenedAt

public String getOpenedAt()

Getter for OpenedAt. The shift start time in ISO 8601 format.

Returns:

Returns the String

getEndedAt

public String getEndedAt()

Getter for EndedAt. The shift end time in ISO 8601 format.

Returns:

Returns the String

getClosedAt

public String getClosedAt()

Getter for ClosedAt. The shift close time in ISO 8601 format.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. An employee free-text description of a cash drawer shift.

Returns:

Returns the String

getOpenedCashMoney

public Money getOpenedCashMoney()

Getter for OpenedCashMoney. 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

getExpectedCashMoney

public Money getExpectedCashMoney()

Getter for ExpectedCashMoney. 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

getClosedCashMoney

public Money getClosedCashMoney()

Getter for ClosedCashMoney. 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

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 CashDrawerShiftSummary into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CashDrawerShiftSummary.Builder toBuilder()

Builds a new CashDrawerShiftSummary.Builder object. Creates the instance with the state of the current model.

Returns:

a new CashDrawerShiftSummary.Builder object