Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductPlantIntlTrd" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Product Integration (SAP_COM_0009), Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductPlantIntlTrd

Implements

Index

Constructors

constructor

  • Returns ProductPlantIntlTrd

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 "*".

Optional consumptionTaxCtrlCode

consumptionTaxCtrlCode: undefined | string

Control code for consumption taxes in foreign trade. Maximum length: 16.

nullable

Optional countryOfOrigin

countryOfOrigin: undefined | string

Country of Origin of Product (Non-Preferential Origin). Key of the country in which the product has been produced. You are legally required to specify the country of origin both for export and import.ExportYou prove the origin of a product by presenting the certificate of origin. This is issued and controlled by the relevant authority of the issuing country.This authority confirms the origin of a product and the required information with the certificate of origin.ImportThe relevant authority of the importing country - usually the Ministry of Economic Affairs - stipulates which regulations regarding customs and foreign trade law have to be observed for the certificates of origin accompanying goods.This information is used for foreign trade processing in different areas, such as:Foreign trade lawCustoms lawExample for Europe:Article 9 of the EU origin regulation is the legal regulation for the certificate of origin.The responsible authorities in Germany include:Chamber of Commerce (Industrie- und Handelskammer)Chamber of Handicrafts (Handwerkskammer)Customs office. Maximum length: 3.

nullable

plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

product

product: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

Optional regionOfOrigin

regionOfOrigin: undefined | string

Region of Origin. Describes more precisely the origin of goods. You can enter a region of the country from which the goods originate.This information is required for the declarations regarding goods dispatches/imports and goods receipts/exports which are made to the authorities. Declarations to the authorities for foreign trade are a legal requirement in many countries.INTRASTAT - Declaration in the European UnionEXTRASTAT - Declaration in the European UnionIn the products management document, the 'region of destination' field indicates the region of the receiving plant. Maximum length: 3.

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

Static ALL_FIELDS

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

All fields selector.

Static CONSUMPTION_TAX_CTRL_CODE

CONSUMPTION_TAX_CTRL_CODE: StringField<ProductPlantIntlTrd> = new StringField('ConsumptionTaxCtrlCode', ProductPlantIntlTrd, 'Edm.String')

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

Static COUNTRY_OF_ORIGIN

COUNTRY_OF_ORIGIN: StringField<ProductPlantIntlTrd> = new StringField('CountryOfOrigin', ProductPlantIntlTrd, 'Edm.String')

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

Static PLANT

PLANT: StringField<ProductPlantIntlTrd> = new StringField('Plant', ProductPlantIntlTrd, 'Edm.String')

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

Static PRODUCT

PRODUCT: StringField<ProductPlantIntlTrd> = new StringField('Product', ProductPlantIntlTrd, 'Edm.String')

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

Static REGION_OF_ORIGIN

REGION_OF_ORIGIN: StringField<ProductPlantIntlTrd> = new StringField('RegionOfOrigin', ProductPlantIntlTrd, 'Edm.String')

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

Static _allFields

_allFields: Array<StringField<ProductPlantIntlTrd>> = [ProductPlantIntlTrd.PRODUCT,ProductPlantIntlTrd.PLANT,ProductPlantIntlTrd.COUNTRY_OF_ORIGIN,ProductPlantIntlTrd.REGION_OF_ORIGIN,ProductPlantIntlTrd.CONSUMPTION_TAX_CTRL_CODE]

All fields of the ProductPlantIntlTrd entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductPlantIntlTrd"

Technical entity name for ProductPlantIntlTrd.

Static _keyFields

_keyFields: Array<Selectable<ProductPlantIntlTrd>> = [ProductPlantIntlTrd.PRODUCT, ProductPlantIntlTrd.PLANT]

All key fields of the ProductPlantIntlTrd entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductPlantIntlTrd>

    A builder that constructs instances of entity type ProductPlantIntlTrd.

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 ProductPlantIntlTrd entity type.

    Returns ProductPlantIntlTrdRequestBuilder

    A ProductPlantIntlTrd request builder.