Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "CustomerSupplierCountryText" of service "API_GRMASTERDATA_SRV". This service is part of the following communication scenarios: Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241), Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336). See https://api.sap.com/api/API_GRMASTERDATA_SRV for more information.

Hierarchy

  • Entity
    • CustomerSupplierCountryText

Implements

Index

Constructors

constructor

  • Returns CustomerSupplierCountryText

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. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

Optional customerSupplierCountryText

customerSupplierCountryText: string

Country Name (Max. 50 Characters). Tthe country description (short form) The country description is used in the address format and on the user interface instead of the country key, or in addition to the country key.There are two fields for the country description. This fifty-character field, and a shorter fifteen-character field.Both fields contain the short description of the country, according to ISO 3166-1.For some countries, the fifteen-character field contains only a shortened form of the description, due to the field length.The fifty-character field contains the short description without abbreviations (but not the official, complete country name). Maximum length: 50.

nullable

language

language: string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.

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

toCnsldtnCountry

toCnsldtnCountry: CustomerSupplierCountry

One-to-one navigation property to the CustomerSupplierCountry entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COUNTRY

COUNTRY: StringField<CustomerSupplierCountryText> = new StringField('Country', CustomerSupplierCountryText, '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 CUSTOMER_SUPPLIER_COUNTRY_TEXT

CUSTOMER_SUPPLIER_COUNTRY_TEXT: StringField<CustomerSupplierCountryText> = new StringField('CustomerSupplierCountryText', CustomerSupplierCountryText, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<CustomerSupplierCountryText> = new StringField('Language', CustomerSupplierCountryText, 'Edm.String')

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

Static TO_CNSLDTN_COUNTRY

TO_CNSLDTN_COUNTRY: OneToOneLink<CustomerSupplierCountryText, CustomerSupplierCountry> = new OneToOneLink('to_CnsldtnCountry', CustomerSupplierCountryText, CustomerSupplierCountry)

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

Static _allFields

_allFields: Array<StringField<CustomerSupplierCountryText> | OneToOneLink<CustomerSupplierCountryText, CustomerSupplierCountry>> = [CustomerSupplierCountryText.LANGUAGE,CustomerSupplierCountryText.COUNTRY,CustomerSupplierCountryText.CUSTOMER_SUPPLIER_COUNTRY_TEXT,CustomerSupplierCountryText.TO_CNSLDTN_COUNTRY]

All fields of the CustomerSupplierCountryText entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "CustomerSupplierCountryText"

Technical entity name for CustomerSupplierCountryText.

Static _keyFields

_keyFields: Array<Selectable<CustomerSupplierCountryText>> = [CustomerSupplierCountryText.LANGUAGE, CustomerSupplierCountryText.COUNTRY]

All key fields of the CustomerSupplierCountryText entity.

Static _keys

_keys: any = CustomerSupplierCountryText._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_GRMASTERDATA_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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

  • Returns a selectable object that allows the selection of custom field in a get request for the entity CustomerSupplierCountryText.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustomerSupplierCountryText>

    A builder that constructs instances of entity type CustomerSupplierCountryText.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns CustomerSupplierCountryTextRequestBuilder

    A CustomerSupplierCountryText request builder.