com.squareup.square.models

Class ShiftFilter

java.lang.Object

com.squareup.square.models.ShiftFilter

public class ShiftFilter
extends Object

This is a model class for ShiftFilter type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ShiftFilter(List<String> locationIds, List<String> teamMemberIds, List<String> employeeIds, String status, TimeRange start, TimeRange end, ShiftWorkday workday) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getEmployeeIds() Getter for EmployeeIds.
TimeRange	getEnd() Getter for End.
List<String>	getLocationIds() Getter for LocationIds.
TimeRange	getStart() Getter for Start.
String	getStatus() Getter for Status.
List<String>	getTeamMemberIds() Getter for TeamMemberIds.
ShiftWorkday	getWorkday() Getter for Workday.
int	hashCode()
ShiftFilter.Builder	toBuilder() Builds a new ShiftFilter.Builder object.
String	toString() Converts this ShiftFilter into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShiftFilter

public ShiftFilter(List<String> locationIds,
                   List<String> teamMemberIds,
                   List<String> employeeIds,
                   String status,
                   TimeRange start,
                   TimeRange end,
                   ShiftWorkday workday)

Initialization constructor.

Parameters:

locationIds - List of String value for locationIds.

teamMemberIds - List of String value for teamMemberIds.

employeeIds - List of String value for employeeIds.

status - String value for status.

start - TimeRange value for start.

end - TimeRange value for end.

workday - ShiftWorkday value for workday.

Method Detail

getLocationIds

public List<String> getLocationIds()

Getter for LocationIds. Fetch shifts for the specified location.

Returns:

Returns the List of String

getEmployeeIds

public List<String> getEmployeeIds()

Getter for EmployeeIds. Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead.

Returns:

Returns the List of String

getStatus

public String getStatus()

Getter for Status. Specifies the `status` of `Shift` records to be returned.

Returns:

Returns the String

getStart

public TimeRange getStart()

Getter for Start. Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

Returns:

Returns the TimeRange

getEnd

public TimeRange getEnd()

Getter for End. Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

Returns:

Returns the TimeRange

getWorkday

public ShiftWorkday getWorkday()

Getter for Workday. A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.

Returns:

Returns the ShiftWorkday

getTeamMemberIds

public List<String> getTeamMemberIds()

Getter for TeamMemberIds. Fetch shifts for the specified team members. Replaced `employee_ids` at version "2020-08-26".

Returns:

Returns the List of 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 ShiftFilter into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ShiftFilter.Builder toBuilder()

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

Returns:

a new ShiftFilter.Builder object