Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_Country" of service "API_COUNTRY_SRV". This service is part of the following communication scenarios: SAP Business Objects Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_COUNTRY_SRV for more information.

Hierarchy

  • Entity
    • Country

Implements

Index

Constructors

constructor

  • Returns Country

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

country

country: string

Country Key. Here you specify the country key for the customer or vendor. Maximum length: 3.

Optional countryCurrency

countryCurrency: undefined | string

Country Currency. Key for the country currency. If the tax amounts for particular codes are reported in a country other than the company code country, then it is necessary to translate them into the corresponding country currency. The currency key specified here is used for this translation.The "Plants abroad" parameter must be active in order to use this field. Maximum length: 5.

nullable

Optional countryThreeDigitIsoCode

countryThreeDigitIsoCode: undefined | string

ISO Country Code Numeric 3-Characters. 3-character numeric ISO country code This 3-character numeric ISO country code is listed for all countries, for example, in the Internet under the address http://www.un.org/Depts/unsd/methods/m49alpha.htm.The code is not to be confused with the 2-character ISO country code, which is more frequently used, the 3-character numeric INTRASTAT country code, or the 3-character non-numeric ISO country code.The use of this 3-character numeric ISO code is required by law in countries such as Romania and Croatia. Maximum length: 3.

nullable

Optional countryThreeLetterIsoCode

countryThreeLetterIsoCode: undefined | string

ISO Country Code 3 Characters. International standardized 3-character country key The key is used, e.g. for data exchange with banks via OFX (Open Financial Exchange).It is not the same as the more commonly used 2-character ISO country code or the 3-character numeric INTRASTAT country code.Enter the 3-character ISO country code for all countries if you want to exchange data with banks via OFX. Maximum length: 3.

nullable

Optional hardCurrency

hardCurrency: undefined | string

Currency Key of the Hard Currency. Specifies the country-specific second currency. A hard currency is used in countries with high inflation. Maximum length: 5.

nullable

Optional indexBasedCurrency

indexBasedCurrency: undefined | string

Currency Key of the Index-Based Currency. Specifies the country-specific, fictitious currency. An index-based currency is stipulated for external reporting (for example, tax returns), in some countries with high inflation. Maximum length: 5.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional taxCalculationProcedure

taxCalculationProcedure: undefined | string

Procedure (Pricing, Output Control, Acct. Det., Costing,...). Specifies the conditions that are allowed for a document and defines the sequence in which they are used. Procedures are used, for example, in the following applications:Pricing in Sales and DistributionAccount determinationCalculating taxes on sales/purchases. Maximum length: 6.

nullable

toText

toText: CountryText[]

One-to-many navigation property to the CountryText entity.

Static ALL_FIELDS

ALL_FIELDS: AllFields<Country> = new AllFields('*', Country)

All fields selector.

Static COUNTRY

COUNTRY: StringField<Country> = new StringField('Country', Country, 'Edm.String')

Static representation of the country property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COUNTRY_CURRENCY

COUNTRY_CURRENCY: StringField<Country> = new StringField('CountryCurrency', Country, 'Edm.String')

Static representation of the countryCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COUNTRY_THREE_DIGIT_ISO_CODE

COUNTRY_THREE_DIGIT_ISO_CODE: StringField<Country> = new StringField('CountryThreeDigitISOCode', Country, 'Edm.String')

Static representation of the countryThreeDigitIsoCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COUNTRY_THREE_LETTER_ISO_CODE

COUNTRY_THREE_LETTER_ISO_CODE: StringField<Country> = new StringField('CountryThreeLetterISOCode', Country, 'Edm.String')

Static representation of the countryThreeLetterIsoCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static HARD_CURRENCY

HARD_CURRENCY: StringField<Country> = new StringField('HardCurrency', Country, 'Edm.String')

Static representation of the hardCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INDEX_BASED_CURRENCY

INDEX_BASED_CURRENCY: StringField<Country> = new StringField('IndexBasedCurrency', Country, 'Edm.String')

Static representation of the indexBasedCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TAX_CALCULATION_PROCEDURE

TAX_CALCULATION_PROCEDURE: StringField<Country> = new StringField('TaxCalculationProcedure', Country, 'Edm.String')

Static representation of the taxCalculationProcedure property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_TEXT

TO_TEXT: Link<Country, CountryText> = new Link('to_Text', Country, CountryText)

Static representation of the one-to-many navigation property toText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<Country> | Link<Country, CountryText>> = [Country.COUNTRY,Country.COUNTRY_CURRENCY,Country.INDEX_BASED_CURRENCY,Country.HARD_CURRENCY,Country.TAX_CALCULATION_PROCEDURE,Country.COUNTRY_THREE_LETTER_ISO_CODE,Country.COUNTRY_THREE_DIGIT_ISO_CODE,Country.TO_TEXT]

All fields of the Country entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_COUNTRY_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_Country"

Technical entity name for Country.

Static _keyFields

_keyFields: Array<Selectable<Country>> = [Country.COUNTRY]

All key fields of the Country entity.

Static _keys

_keys: object = Country._keyFields.reduce((acc: { [keys: string]: Selectable<Country> }, field: Selectable<Country>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property Country.

Type declaration

Static _serviceName

_serviceName: string = "API_COUNTRY_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for Country.

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • customField(fieldName: string): CustomField<Country>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity Country.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Country>

    A builder that constructs instances of entity type Country.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the Country entity type.

    Returns CountryRequestBuilder

    A Country request builder.