com.squareup.square.models

Class CashDrawerShiftEvent

java.lang.Object

com.squareup.square.models.CashDrawerShiftEvent

public class CashDrawerShiftEvent
extends Object

This is a model class for CashDrawerShiftEvent type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CashDrawerShiftEvent(String id, String employeeId, String eventType, Money eventMoney, String createdAt, String description) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCreatedAt() Getter for CreatedAt.
String	getDescription() Getter for Description.
String	getEmployeeId() Getter for EmployeeId.
Money	getEventMoney() Getter for EventMoney.
String	getEventType() Getter for EventType.
String	getId() Getter for Id.
int	hashCode()
CashDrawerShiftEvent.Builder	toBuilder() Builds a new CashDrawerShiftEvent.Builder object.
String	toString() Converts this CashDrawerShiftEvent into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CashDrawerShiftEvent

public CashDrawerShiftEvent(String id,
                            String employeeId,
                            String eventType,
                            Money eventMoney,
                            String createdAt,
                            String description)

Initialization constructor.

Parameters:

id - String value for id.

employeeId - String value for employeeId.

eventType - String value for eventType.

eventMoney - Money value for eventMoney.

createdAt - String value for createdAt.

description - String value for description.

Method Detail

getId

public String getId()

Getter for Id. The unique ID of the event.

Returns:

Returns the String

getEmployeeId

public String getEmployeeId()

Getter for EmployeeId. The ID of the employee that created the event.

Returns:

Returns the String

getEventType

public String getEventType()

Getter for EventType. The types of events on a CashDrawerShift. Each event type represents an employee action on the actual cash drawer represented by a CashDrawerShift.

Returns:

Returns the String

getEventMoney

public Money getEventMoney()

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

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The event time in ISO 8601 format.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. An optional description of the event, entered by the employee that created the event.

Returns:

Returns the 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 CashDrawerShiftEvent into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CashDrawerShiftEvent.Builder toBuilder()

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

Returns:

a new CashDrawerShiftEvent.Builder object