Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierPartnerFunc" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.

Hierarchy

  • Entity
    • SupplierPartnerFunc

Implements

Index

Constructors

constructor

  • Returns SupplierPartnerFunc

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 authorizationGroup

authorizationGroup: undefined | string

Authorization Group. The authorization group allows extended authorization protection for particular objects. The authorization groups are freely definable. The authorization groups usually occur in authorization objects together with an activity. Maximum length: 4.

nullable

Optional createdByUser

createdByUser: undefined | string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional defaultPartner

defaultPartner: undefined | false | true

Default Partner. Specifies a partner as the default for a particular partner function. When you enter more than one partner for a particular partner function (for example, you define three different ship-to parties), you can select one partner as the default. During sales or purchasing processing, if you have defined multiple partners for a partner function, the system prompts you to choose just one partner. The system presents the default partner as the first choice in the pop-up window.

nullable

partnerCounter

partnerCounter: string

Partner counter. The sequential number that the system applies when there is more than one partner for a particular partner function. When you create a sales order for a particular customer, there may be more than one ship-to party defined. The different ship-to parties are numbered sequentially. Maximum length: 3.

partnerFunction

partnerFunction: string

Partner Function. The abbreviated form of the name that identifies the partner function. Maximum length: 2.

plant

plant: string

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

purchasingOrganization

purchasingOrganization: string

Purchasing Organization. Denotes the purchasing organization. Maximum length: 4.

Optional referenceSupplier

referenceSupplier: undefined | string

Reference to other vendor. Maximum length: 10.

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

supplier

supplier: string

Account Number of Supplier. Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system. Maximum length: 10.

supplierSubrange

supplierSubrange: string

Supplier Subrange. Subdivision of a supplier's overall product range according to various criteria. For each supplier sub-range:The master data is kept on a common basisCertain conditions applyIn the supplier master, you can create different purchasing data and different partner functions for each supplier sub-range.You can also maintain and change the conditions for each supplier sub-range. You assign a material to a supplier sub-range in the info record.In the supplier master, you can maintain different data for particular supplier sub-ranges, such as ordering addresses or terms of payment, for example.When creating a purchase order with a known supplier, different data is only determined if the supplier sub-range is entered in the initial screen.Your supplier Smith in Houston has two sub-ranges: paint and glue.All materials from the "paint" sub-range are ordered in Houston.You have maintained an alternative ordering address in Detroit for the "glue" sub-range.If you order materials from the "glue" sub-range, the supplier sub-range finds the Detroit ordering address. Maximum length: 6.

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<SupplierPartnerFunc> = new AllFields('*', SupplierPartnerFunc)

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<SupplierPartnerFunc> = new StringField('AuthorizationGroup', SupplierPartnerFunc, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<SupplierPartnerFunc> = new StringField('CreatedByUser', SupplierPartnerFunc, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<SupplierPartnerFunc> = new DateField('CreationDate', SupplierPartnerFunc, 'Edm.DateTime')

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

Static DEFAULT_PARTNER

DEFAULT_PARTNER: BooleanField<SupplierPartnerFunc> = new BooleanField('DefaultPartner', SupplierPartnerFunc, 'Edm.Boolean')

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

Static PARTNER_COUNTER

PARTNER_COUNTER: StringField<SupplierPartnerFunc> = new StringField('PartnerCounter', SupplierPartnerFunc, 'Edm.String')

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

Static PARTNER_FUNCTION

PARTNER_FUNCTION: StringField<SupplierPartnerFunc> = new StringField('PartnerFunction', SupplierPartnerFunc, 'Edm.String')

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

Static PLANT

PLANT: StringField<SupplierPartnerFunc> = new StringField('Plant', SupplierPartnerFunc, '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 PURCHASING_ORGANIZATION

PURCHASING_ORGANIZATION: StringField<SupplierPartnerFunc> = new StringField('PurchasingOrganization', SupplierPartnerFunc, 'Edm.String')

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

Static REFERENCE_SUPPLIER

REFERENCE_SUPPLIER: StringField<SupplierPartnerFunc> = new StringField('ReferenceSupplier', SupplierPartnerFunc, 'Edm.String')

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

Static SUPPLIER

SUPPLIER: StringField<SupplierPartnerFunc> = new StringField('Supplier', SupplierPartnerFunc, 'Edm.String')

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

Static SUPPLIER_SUBRANGE

SUPPLIER_SUBRANGE: StringField<SupplierPartnerFunc> = new StringField('SupplierSubrange', SupplierPartnerFunc, 'Edm.String')

Static representation of the supplierSubrange 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<SupplierPartnerFunc> | BooleanField<SupplierPartnerFunc> | DateField<SupplierPartnerFunc>> = [SupplierPartnerFunc.SUPPLIER,SupplierPartnerFunc.PURCHASING_ORGANIZATION,SupplierPartnerFunc.SUPPLIER_SUBRANGE,SupplierPartnerFunc.PLANT,SupplierPartnerFunc.PARTNER_FUNCTION,SupplierPartnerFunc.PARTNER_COUNTER,SupplierPartnerFunc.DEFAULT_PARTNER,SupplierPartnerFunc.CREATION_DATE,SupplierPartnerFunc.CREATED_BY_USER,SupplierPartnerFunc.REFERENCE_SUPPLIER,SupplierPartnerFunc.AUTHORIZATION_GROUP]

All fields of the SupplierPartnerFunc entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierPartnerFunc"

Technical entity name for SupplierPartnerFunc.

Static _keyFields

_keyFields: Array<Selectable<SupplierPartnerFunc>> = [SupplierPartnerFunc.SUPPLIER, SupplierPartnerFunc.PURCHASING_ORGANIZATION, SupplierPartnerFunc.SUPPLIER_SUBRANGE, SupplierPartnerFunc.PLANT, SupplierPartnerFunc.PARTNER_FUNCTION, SupplierPartnerFunc.PARTNER_COUNTER]

All key fields of the SupplierPartnerFunc entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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 | 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 SupplierPartnerFunc.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierPartnerFunc>

    A builder that constructs instances of entity type SupplierPartnerFunc.

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

    Returns SupplierPartnerFuncRequestBuilder

    A SupplierPartnerFunc request builder.