Package com.oracle.bmc.ospgateway.model

Class SubscriptionSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.ospgateway.model.SubscriptionSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191001")
public final class SubscriptionSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Subscription object which contains the common subscription data.
Note: Objects should always be created or deserialized using the SubscriptionSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SubscriptionSummary.Builder, which maintain a set of all explicitly set fields called SubscriptionSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionSummary.AccountType	Account type.
static class	SubscriptionSummary.Builder
static class	SubscriptionSummary.PlanType	Subscription plan type.
static class	SubscriptionSummary.UpgradeState	Status of the upgrade.
static class	SubscriptionSummary.UpgradeStateDetails	This field is used to describe the Upgrade State in case of error (E.g.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

SubscriptionSummary(String id, String subscriptionPlanNumber, SubscriptionSummary.PlanType planType, Date timeStart, String shipToCustAcctSiteId, String shipToCustAcctRoleId, String billToCustAccountId, Boolean isIntentToPay, Boolean isCorporateConversionAllowed, String currencyCode, String gsiOrgCode, String languageCode, String organizationId, SubscriptionSummary.UpgradeState upgradeState, SubscriptionSummary.UpgradeStateDetails upgradeStateDetails, SubscriptionSummary.AccountType accountType, TaxInfo taxInfo, List<PaymentOption> paymentOptions, PaymentGateway paymentGateway, Address billingAddress, Date timePlanUpgrade, Date timePersonalToCorporateConv)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static SubscriptionSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
SubscriptionSummary.AccountType	getAccountType()	Account type.
Address	getBillingAddress()
String	getBillToCustAccountId()	Bill to customer Account id.
String	getCurrencyCode()	Currency code
String	getGsiOrgCode()	GSI Subscription external code.
String	getId()	Subscription id identifier (OCID).
Boolean	getIsCorporateConversionAllowed()	Corporate conversion allowed status
Boolean	getIsIntentToPay()	Payment intension.
String	getLanguageCode()	Language short code (en, de, hu, etc)
String	getOrganizationId()	GSI organization external identifier.
PaymentGateway	getPaymentGateway()
List<PaymentOption>	getPaymentOptions()	Payment option list of a subscription.
SubscriptionSummary.PlanType	getPlanType()	Subscription plan type.
String	getShipToCustAcctRoleId()	Ship to customer account role.
String	getShipToCustAcctSiteId()	Ship to customer account site address id.
String	getSubscriptionPlanNumber()	Subscription plan number.
TaxInfo	getTaxInfo()
Date	getTimePersonalToCorporateConv()	Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
Date	getTimePlanUpgrade()	Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
Date	getTimeStart()	Start date of the subscription.
SubscriptionSummary.UpgradeState	getUpgradeState()	Status of the upgrade.
SubscriptionSummary.UpgradeStateDetails	getUpgradeStateDetails()	This field is used to describe the Upgrade State in case of error (E.g.
int	hashCode()
SubscriptionSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionSummary

@Deprecated
@ConstructorProperties({"id","subscriptionPlanNumber","planType","timeStart","shipToCustAcctSiteId","shipToCustAcctRoleId","billToCustAccountId","isIntentToPay","isCorporateConversionAllowed","currencyCode","gsiOrgCode","languageCode","organizationId","upgradeState","upgradeStateDetails","accountType","taxInfo","paymentOptions","paymentGateway","billingAddress","timePlanUpgrade","timePersonalToCorporateConv"})
public SubscriptionSummary(String id,
                           String subscriptionPlanNumber,
                           SubscriptionSummary.PlanType planType,
                           Date timeStart,
                           String shipToCustAcctSiteId,
                           String shipToCustAcctRoleId,
                           String billToCustAccountId,
                           Boolean isIntentToPay,
                           Boolean isCorporateConversionAllowed,
                           String currencyCode,
                           String gsiOrgCode,
                           String languageCode,
                           String organizationId,
                           SubscriptionSummary.UpgradeState upgradeState,
                           SubscriptionSummary.UpgradeStateDetails upgradeStateDetails,
                           SubscriptionSummary.AccountType accountType,
                           TaxInfo taxInfo,
                           List<PaymentOption> paymentOptions,
                           PaymentGateway paymentGateway,
                           Address billingAddress,
                           Date timePlanUpgrade,
                           Date timePersonalToCorporateConv)

Deprecated.

Method Detail

builder

public static SubscriptionSummary.Builder builder()

Create a new builder.

toBuilder

public SubscriptionSummary.Builder toBuilder()

getId

public String getId()

Subscription id identifier (OCID).

Returns:

the value

getSubscriptionPlanNumber

public String getSubscriptionPlanNumber()

Subscription plan number.

Returns:

the value

getPlanType

public SubscriptionSummary.PlanType getPlanType()

Subscription plan type.

Returns:

the value

getTimeStart

public Date getTimeStart()

Start date of the subscription.

Returns:

the value

getShipToCustAcctSiteId

public String getShipToCustAcctSiteId()

Ship to customer account site address id.

Returns:

the value

getShipToCustAcctRoleId

public String getShipToCustAcctRoleId()

Ship to customer account role.

Returns:

the value

getBillToCustAccountId

public String getBillToCustAccountId()

Bill to customer Account id.

Returns:

the value

getIsIntentToPay

public Boolean getIsIntentToPay()

Payment intension.

Returns:

the value

getIsCorporateConversionAllowed

public Boolean getIsCorporateConversionAllowed()

Corporate conversion allowed status

Returns:

the value

getCurrencyCode

public String getCurrencyCode()

Currency code

Returns:

the value

getGsiOrgCode

public String getGsiOrgCode()

GSI Subscription external code.

Returns:

the value

getLanguageCode

public String getLanguageCode()

Language short code (en, de, hu, etc)

Returns:

the value

getOrganizationId

public String getOrganizationId()

GSI organization external identifier.

Returns:

the value

getUpgradeState

public SubscriptionSummary.UpgradeState getUpgradeState()

Status of the upgrade.

Returns:

the value

getUpgradeStateDetails

public SubscriptionSummary.UpgradeStateDetails getUpgradeStateDetails()

This field is used to describe the Upgrade State in case of error (E.g.

Upgrade failure caused by interfacing Tax details- TaxError)

Returns:

the value

getAccountType

public SubscriptionSummary.AccountType getAccountType()

Account type.

Returns:

the value

getTaxInfo

public TaxInfo getTaxInfo()

getPaymentOptions

public List<PaymentOption> getPaymentOptions()

Payment option list of a subscription.

Returns:

the value

getPaymentGateway

public PaymentGateway getPaymentGateway()

getBillingAddress

public Address getBillingAddress()

getTimePlanUpgrade

public Date getTimePlanUpgrade()

Date of upgrade/conversion when planType changed from FREE_TIER to PAYG

Returns:

the value

getTimePersonalToCorporateConv

public Date getTimePersonalToCorporateConv()

Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel