Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SlsOrdWthoutChrgItmPartner" of service "API_SALES_ORDER_WITHOUT_CHARGE_SRV". This service is part of the following communication scenarios: Sales Order Without Charge Integration (SAP_COM_0334). See https://api.sap.com/api/API_SALES_ORDER_WITHOUT_CHARGE_SRV for more information.

Hierarchy

  • Entity
    • SlsOrdWthoutChrgItmPartner

Implements

Index

Constructors

constructor

  • Returns SlsOrdWthoutChrgItmPartner

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 contactPerson

contactPerson: string

Number of contact person. The number that uniquely identifies the contact person. Maximum length: 10.

nullable

Optional customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

nullable

partnerFunction

partnerFunction: string

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

Optional personnel

personnel: string

Personnel Number. The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data. Maximum length: 8.

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

salesOrderWithoutCharge

salesOrderWithoutCharge: string

Sales Order Without Charge. Maximum length: 10.

salesOrderWithoutChargeItem

salesOrderWithoutChargeItem: string

Sales Order Without Charge Item. Maximum length: 6.

Optional supplier

supplier: string

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

nullable

toItem

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

toSalesOrderWithoutCharge

toSalesOrderWithoutCharge: SalesOrderWithoutCharge

One-to-one navigation property to the SalesOrderWithoutCharge 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<SlsOrdWthoutChrgItmPartner> = new AllFields('*', SlsOrdWthoutChrgItmPartner)

All fields selector.

Static CONTACT_PERSON

CONTACT_PERSON: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('ContactPerson', SlsOrdWthoutChrgItmPartner, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('Customer', SlsOrdWthoutChrgItmPartner, 'Edm.String')

Static representation of the customer 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<SlsOrdWthoutChrgItmPartner> = new StringField('PartnerFunction', SlsOrdWthoutChrgItmPartner, '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 PERSONNEL

PERSONNEL: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('Personnel', SlsOrdWthoutChrgItmPartner, 'Edm.String')

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

Static SALES_ORDER_WITHOUT_CHARGE

SALES_ORDER_WITHOUT_CHARGE: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('SalesOrderWithoutCharge', SlsOrdWthoutChrgItmPartner, 'Edm.String')

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

Static SALES_ORDER_WITHOUT_CHARGE_ITEM

SALES_ORDER_WITHOUT_CHARGE_ITEM: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('SalesOrderWithoutChargeItem', SlsOrdWthoutChrgItmPartner, 'Edm.String')

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

Static SUPPLIER

SUPPLIER: StringField<SlsOrdWthoutChrgItmPartner> = new StringField('Supplier', SlsOrdWthoutChrgItmPartner, '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 TO_ITEM

TO_ITEM: OneToOneLink<SlsOrdWthoutChrgItmPartner, SalesOrderWithoutChargeItem> = new OneToOneLink('to_Item', SlsOrdWthoutChrgItmPartner, SalesOrderWithoutChargeItem)

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

Static TO_SALES_ORDER_WITHOUT_CHARGE

TO_SALES_ORDER_WITHOUT_CHARGE: OneToOneLink<SlsOrdWthoutChrgItmPartner, SalesOrderWithoutCharge> = new OneToOneLink('to_SalesOrderWithoutCharge', SlsOrdWthoutChrgItmPartner, SalesOrderWithoutCharge)

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

Static _allFields

_allFields: Array<StringField<SlsOrdWthoutChrgItmPartner> | OneToOneLink<SlsOrdWthoutChrgItmPartner, SalesOrderWithoutChargeItem> | OneToOneLink<SlsOrdWthoutChrgItmPartner, SalesOrderWithoutCharge>> = [SlsOrdWthoutChrgItmPartner.SALES_ORDER_WITHOUT_CHARGE,SlsOrdWthoutChrgItmPartner.SALES_ORDER_WITHOUT_CHARGE_ITEM,SlsOrdWthoutChrgItmPartner.PARTNER_FUNCTION,SlsOrdWthoutChrgItmPartner.CUSTOMER,SlsOrdWthoutChrgItmPartner.SUPPLIER,SlsOrdWthoutChrgItmPartner.PERSONNEL,SlsOrdWthoutChrgItmPartner.CONTACT_PERSON,SlsOrdWthoutChrgItmPartner.TO_ITEM,SlsOrdWthoutChrgItmPartner.TO_SALES_ORDER_WITHOUT_CHARGE]

All fields of the SlsOrdWthoutChrgItmPartner entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SlsOrdWthoutChrgItmPartner"

Technical entity name for SlsOrdWthoutChrgItmPartner.

Static _keyFields

_keyFields: Array<Selectable<SlsOrdWthoutChrgItmPartner>> = [SlsOrdWthoutChrgItmPartner.SALES_ORDER_WITHOUT_CHARGE, SlsOrdWthoutChrgItmPartner.SALES_ORDER_WITHOUT_CHARGE_ITEM, SlsOrdWthoutChrgItmPartner.PARTNER_FUNCTION]

All key fields of the SlsOrdWthoutChrgItmPartner entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_SALES_ORDER_WITHOUT_CHARGE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SlsOrdWthoutChrgItmPartner>

    A builder that constructs instances of entity type SlsOrdWthoutChrgItmPartner.

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

    Returns SlsOrdWthoutChrgItmPartnerRequestBuilder

    A SlsOrdWthoutChrgItmPartner request builder.