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 serviceList<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<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 presentCountry.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Country.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this 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 interfaceMaskable
-
withMask
Country.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
getAllVatCountryCodesAndVatIdRegexes
This method is to get the collection of VAT country codes and VAT ID Regexes. -
getAvailableCountries
Use this method to retrieve a list of countries and locale information available to the current user. -
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
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. -
getObject
- See Also:
- SoftLayer_Locale_Country::getObject
-
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. -
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. -
isEuropeanUnionCountry
Returns true if the country code is in the European Union (EU), false otherwise. -
getStates
States that belong to this country.- See Also:
- SoftLayer_Locale_Country::getStates
-