com.squareup.square.models

Class Phase

java.lang.Object

com.squareup.square.models.Phase

public class Phase
extends Object

This is a model class for Phase type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Phase(io.apimatic.core.types.OptionalNullable<String> uid, io.apimatic.core.types.OptionalNullable<Long> ordinal, io.apimatic.core.types.OptionalNullable<String> orderTemplateId, io.apimatic.core.types.OptionalNullable<String> planPhaseUid) Initialization constructor.
	Phase(String uid, Long ordinal, String orderTemplateId, String planPhaseUid) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getOrderTemplateId() Getter for OrderTemplateId.
Long	getOrdinal() Getter for Ordinal.
String	getPlanPhaseUid() Getter for PlanPhaseUid.
String	getUid() Getter for Uid.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOrderTemplateId() Internal Getter for OrderTemplateId.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetOrdinal() Internal Getter for Ordinal.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetPlanPhaseUid() Internal Getter for PlanPhaseUid.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUid() Internal Getter for Uid.
Phase.Builder	toBuilder() Builds a new Phase.Builder object.
String	toString() Converts this Phase into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Phase

public Phase(String uid,
             Long ordinal,
             String orderTemplateId,
             String planPhaseUid)

Initialization constructor.

Parameters:

uid - String value for uid.

ordinal - Long value for ordinal.

orderTemplateId - String value for orderTemplateId.

planPhaseUid - String value for planPhaseUid.

Phase

protected Phase(io.apimatic.core.types.OptionalNullable<String> uid,
                io.apimatic.core.types.OptionalNullable<Long> ordinal,
                io.apimatic.core.types.OptionalNullable<String> orderTemplateId,
                io.apimatic.core.types.OptionalNullable<String> planPhaseUid)

Initialization constructor.

Parameters:

uid - String value for uid.

ordinal - Long value for ordinal.

orderTemplateId - String value for orderTemplateId.

planPhaseUid - String value for planPhaseUid.

Method Detail

internalGetUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()

Internal Getter for Uid. id of subscription phase

Returns:

Returns the Internal String

getUid

public String getUid()

Getter for Uid. id of subscription phase

Returns:

Returns the String

internalGetOrdinal

protected io.apimatic.core.types.OptionalNullable<Long> internalGetOrdinal()

Internal Getter for Ordinal. index of phase in total subscription plan

Returns:

Returns the Internal Long

getOrdinal

public Long getOrdinal()

Getter for Ordinal. index of phase in total subscription plan

Returns:

Returns the Long

internalGetOrderTemplateId

protected io.apimatic.core.types.OptionalNullable<String> internalGetOrderTemplateId()

Internal Getter for OrderTemplateId. id of order to be used in billing

Returns:

Returns the Internal String

getOrderTemplateId

public String getOrderTemplateId()

Getter for OrderTemplateId. id of order to be used in billing

Returns:

Returns the String

internalGetPlanPhaseUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetPlanPhaseUid()

Internal Getter for PlanPhaseUid. the uid from the plan's phase in catalog

Returns:

Returns the Internal String

getPlanPhaseUid

public String getPlanPhaseUid()

Getter for PlanPhaseUid. the uid from the plan's phase in catalog

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Phase.Builder toBuilder()

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

Returns:

a new Phase.Builder object