Package com.softlayer.api.service.locale

Interface Country.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Country

@ApiService("SoftLayer_Locale_Country")
public static interface Country.Service
extends Service

This service provides methods to retrieve country locale information.

See Also:

SoftLayer_Locale_Country

Method Summary

Modifier and Type	Method	Description
Country.ServiceAsync	asAsync()	Get an async version of this service
List<VatCountryCodeAndFormat>	getAllVatCountryCodesAndVatIdRegexes()	This method is to get the collection of VAT country codes and VAT ID Regexes.
List<Country>	getAvailableCountries()	Use this method to retrieve a list of countries and locale information available to the current user.
List<Country>	getCountries()	Use this method to retrieve a list of countries and locale information such as country code and state/provinces.
List<CountryCode>	getCountriesAndStates(Boolean usFirstFlag)	This method will return a collection of [[SoftLayer_Container_Collection_Locale_CountryCode]] objects.
Country	getObject()
List<String>	getPostalCodeRequiredCountryCodes()	This method will return an array of country codes that require postal code
List<StateProvince>	getStates()	States that belong to this country.
List<String>	getVatCountries()	This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID.
List<String>	getVatRequiredCountryCodes()	This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID.
Boolean	isEuropeanUnionCountry(String iso2CountryCode)	Returns true if the country code is in the European Union (EU), false otherwise.
void	setMask(Country.Mask mask)
Country.Mask	withMask()	Use the existing mask on this service or create it if not present
Country.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Country.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Country.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Country.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Country.Mask mask)

getAllVatCountryCodesAndVatIdRegexes

@ApiMethod
List<VatCountryCodeAndFormat> getAllVatCountryCodesAndVatIdRegexes()

This method is to get the collection of VAT country codes and VAT ID Regexes.

See Also:

SoftLayer_Locale_Country::getAllVatCountryCodesAndVatIdRegexes

getAvailableCountries

@ApiMethod
List<Country> getAvailableCountries()

Use this method to retrieve a list of countries and locale information available to the current user.

See Also:

SoftLayer_Locale_Country::getAvailableCountries

getCountries

@ApiMethod
List<Country> getCountries()

Use this method to retrieve a list of countries and locale information such as country code and state/provinces.

See Also:

SoftLayer_Locale_Country::getCountries

getCountriesAndStates

@ApiMethod
List<CountryCode> getCountriesAndStates(Boolean usFirstFlag)

This method will return a collection of [[SoftLayer_Container_Collection_Locale_CountryCode]] objects. If the country has states, a [[SoftLayer_Container_Collection_Locale_StateCode]] collection will be provided with the country.

See Also:

SoftLayer_Locale_Country::getCountriesAndStates

getObject

@ApiMethod(instanceRequired=true)
Country getObject()

See Also:

SoftLayer_Locale_Country::getObject

getPostalCodeRequiredCountryCodes

@ApiMethod
List<String> getPostalCodeRequiredCountryCodes()

This method will return an array of country codes that require postal code

See Also:

SoftLayer_Locale_Country::getPostalCodeRequiredCountryCodes

getVatCountries

@ApiMethod
List<String> getVatCountries()

This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [[SoftLayer_Locale_Country/getVatRequiredCountryCodes]] - this method will provide all country codes that use VAT ID, including those which are required.

See Also:

SoftLayer_Locale_Country::getVatCountries

getVatRequiredCountryCodes

@ApiMethod
List<String> getVatRequiredCountryCodes()

This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [[SoftLayer_Locale_Country/getVatCountries]] - this method will provide country codes where a VAT ID is required for onboarding to IBM Cloud.

See Also:

SoftLayer_Locale_Country::getVatRequiredCountryCodes

isEuropeanUnionCountry

@ApiMethod
Boolean isEuropeanUnionCountry(String iso2CountryCode)

Returns true if the country code is in the European Union (EU), false otherwise.

See Also:

SoftLayer_Locale_Country::isEuropeanUnionCountry

getStates

@ApiMethod(instanceRequired=true)
List<StateProvince> getStates()

States that belong to this country.

See Also:

SoftLayer_Locale_Country::getStates