Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ReservationDocumentHeader" of service "API_RESERVATION_DOCUMENT_SRV". This service is part of the following communication scenarios: Reservation Integration (SAP_COM_0112). See https://api.sap.com/api/API_RESERVATION_DOCUMENT_SRV for more information.

Hierarchy

  • Entity
    • ReservationDocumentHeader

Implements

Index

Constructors

constructor

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 assetNumber

assetNumber: string

Main Asset Number. This is the number which, together with the asset sub-number, identifies a fixed asset in Asset Accounting. Maximum length: 12.

nullable

Optional assetSubNumber

assetSubNumber: string

Asset Subnumber. This is the number which, together with the main asset number, uniquely identifies a fixed asset in Asset Accounting. Using the asset sub-number, you can:Provide for separate management of later acquisitions to assets.Represent complex fixed assets with their component parts.In contrast to the main asset number, the asset sub-number must be numerical. Maximum length: 4.

nullable

Optional controllingArea

controllingArea: string

Controlling Area. Uniquely identifies a controlling area. The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary. Maximum length: 4.

nullable

Optional costCenter

costCenter: string

Cost Center. A key that uniquely identifies a cost center. Maximum length: 10.

nullable

Optional customer

customer: string

Account Number of Customer. Uniquely identifies a customer. This customer number is used for managing customer special stocks. Maximum length: 10.

nullable

Optional goodsMovementType

goodsMovementType: string

Goods Movement Type (Inventory Management). Specifies a key for the type of goods movement. Each goods movement (for example, purchase order to warehouse) is allocated to a movement type in the system. Maximum length: 3.

nullable

Optional goodsRecipientName

goodsRecipientName: string

Goods Recipient/Ship-To Party. Specifies the recipient for whom the material or the service is destined. Maximum length: 12.

nullable

Optional isCheckedAgainstFactoryCal

isCheckedAgainstFactoryCal: boolean

Check date against factory calendar. Specifies if the reservation is to be checked against the factory calendar. The system checks the factory calendar to determine whether the dates in the reservation are valid workdays.

nullable

Optional issuingOrReceivingPlant

issuingOrReceivingPlant: string

Receiving/Issuing Plant. Indicates the receiving or issuing plant. The receiving plant is the plant or internal organizational unit that is to receive the goods.The issuing plant is the plant that issues the goods.NoteThe value of the transfer posting is determined not by the plant entered here but by the plant specified in the Plant field. Maximum length: 4.

nullable

Optional issuingOrReceivingStorageLoc

issuingOrReceivingStorageLoc: string

Receiving/Issuing Storage Location. Indicates the receiving or the issuing storage location. The receiving storage location is the storage location that is to receive the goods.The issuing storage location is the storage location that issues the goods. Maximum length: 4.

nullable

Optional networkNumberForAcctAssgmt

networkNumberForAcctAssgmt: string

Network Number for Account Assignment. A network can structure an entire project or a task within a project. Numbers are used to differentiate these project structures.When you specify a network, for example, when you are entering attendances, you can define that the network is debited when the sender cost center is credited.Use the possible entries pushbutton to select the network number for the required project structure. Maximum length: 12.

nullable

Optional orderId

orderId: string

Order Number. Key that uniquely identifies an order within a client. Maximum length: 12.

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

reservation

reservation: string

Number of Reservation/Dependent Requirement. Alphanumeric key uniquely identifying the document. Maximum length: 10.

Optional reservationDate

reservationDate: Moment

Base date for reservation. Specifies the date for which the goods movement is planned.

nullable

Optional salesOrder

salesOrder: string

Sales Order Number. Uniquely identifies a sales order. The selection of postprocessing records via the sales order number is only possible for non-valuated sales order stock. Maximum length: 10.

nullable

Optional salesOrderItem

salesOrderItem: string

Item Number in Sales Order. Uniquely identifies an item within a sales order. Maximum length: 6.

nullable

Optional salesOrderScheduleLine

salesOrderScheduleLine: string

Delivery Schedule for Sales Order. Specifies the number that uniquely identifies an item in . Maximum length: 4.

nullable

toReservationDocumentItem

toReservationDocumentItem: ReservationDocumentItem[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsElement

wbsElement: string

Work Breakdown Structure Element (WBS Element). Key identifying a WBS element. Maximum length: 24.

nullable

Static ALL_FIELDS

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

All fields selector.

Static ASSET_NUMBER

ASSET_NUMBER: StringField<ReservationDocumentHeader> = new StringField('AssetNumber', ReservationDocumentHeader, 'Edm.String')

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

Static ASSET_SUB_NUMBER

ASSET_SUB_NUMBER: StringField<ReservationDocumentHeader> = new StringField('AssetSubNumber', ReservationDocumentHeader, 'Edm.String')

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

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<ReservationDocumentHeader> = new StringField('ControllingArea', ReservationDocumentHeader, 'Edm.String')

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

Static COST_CENTER

COST_CENTER: StringField<ReservationDocumentHeader> = new StringField('CostCenter', ReservationDocumentHeader, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<ReservationDocumentHeader> = new StringField('Customer', ReservationDocumentHeader, '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 GOODS_MOVEMENT_TYPE

GOODS_MOVEMENT_TYPE: StringField<ReservationDocumentHeader> = new StringField('GoodsMovementType', ReservationDocumentHeader, 'Edm.String')

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

Static GOODS_RECIPIENT_NAME

GOODS_RECIPIENT_NAME: StringField<ReservationDocumentHeader> = new StringField('GoodsRecipientName', ReservationDocumentHeader, 'Edm.String')

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

Static ISSUING_OR_RECEIVING_PLANT

ISSUING_OR_RECEIVING_PLANT: StringField<ReservationDocumentHeader> = new StringField('IssuingOrReceivingPlant', ReservationDocumentHeader, 'Edm.String')

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

Static ISSUING_OR_RECEIVING_STORAGE_LOC

ISSUING_OR_RECEIVING_STORAGE_LOC: StringField<ReservationDocumentHeader> = new StringField('IssuingOrReceivingStorageLoc', ReservationDocumentHeader, 'Edm.String')

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

Static IS_CHECKED_AGAINST_FACTORY_CAL

IS_CHECKED_AGAINST_FACTORY_CAL: BooleanField<ReservationDocumentHeader> = new BooleanField('IsCheckedAgainstFactoryCal', ReservationDocumentHeader, 'Edm.Boolean')

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

Static NETWORK_NUMBER_FOR_ACCT_ASSGMT

NETWORK_NUMBER_FOR_ACCT_ASSGMT: StringField<ReservationDocumentHeader> = new StringField('NetworkNumberForAcctAssgmt', ReservationDocumentHeader, 'Edm.String')

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

Static ORDER_ID

ORDER_ID: StringField<ReservationDocumentHeader> = new StringField('OrderID', ReservationDocumentHeader, 'Edm.String')

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

Static RESERVATION

RESERVATION: StringField<ReservationDocumentHeader> = new StringField('Reservation', ReservationDocumentHeader, 'Edm.String')

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

Static RESERVATION_DATE

RESERVATION_DATE: DateField<ReservationDocumentHeader> = new DateField('ReservationDate', ReservationDocumentHeader, 'Edm.DateTime')

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

Static SALES_ORDER

SALES_ORDER: StringField<ReservationDocumentHeader> = new StringField('SalesOrder', ReservationDocumentHeader, 'Edm.String')

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

Static SALES_ORDER_ITEM

SALES_ORDER_ITEM: StringField<ReservationDocumentHeader> = new StringField('SalesOrderItem', ReservationDocumentHeader, 'Edm.String')

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

Static SALES_ORDER_SCHEDULE_LINE

SALES_ORDER_SCHEDULE_LINE: StringField<ReservationDocumentHeader> = new StringField('SalesOrderScheduleLine', ReservationDocumentHeader, 'Edm.String')

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

Static TO_RESERVATION_DOCUMENT_ITEM

TO_RESERVATION_DOCUMENT_ITEM: Link<ReservationDocumentHeader, ReservationDocumentItem> = new Link('to_ReservationDocumentItem', ReservationDocumentHeader, ReservationDocumentItem)

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

Static WBS_ELEMENT

WBS_ELEMENT: StringField<ReservationDocumentHeader> = new StringField('WBSElement', ReservationDocumentHeader, 'Edm.String')

Static representation of the wbsElement 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<ReservationDocumentHeader> | DateField<ReservationDocumentHeader> | BooleanField<ReservationDocumentHeader> | Link<ReservationDocumentHeader, ReservationDocumentItem>> = [ReservationDocumentHeader.RESERVATION,ReservationDocumentHeader.ORDER_ID,ReservationDocumentHeader.GOODS_MOVEMENT_TYPE,ReservationDocumentHeader.COST_CENTER,ReservationDocumentHeader.GOODS_RECIPIENT_NAME,ReservationDocumentHeader.RESERVATION_DATE,ReservationDocumentHeader.IS_CHECKED_AGAINST_FACTORY_CAL,ReservationDocumentHeader.CUSTOMER,ReservationDocumentHeader.WBS_ELEMENT,ReservationDocumentHeader.CONTROLLING_AREA,ReservationDocumentHeader.SALES_ORDER,ReservationDocumentHeader.SALES_ORDER_ITEM,ReservationDocumentHeader.SALES_ORDER_SCHEDULE_LINE,ReservationDocumentHeader.ASSET_NUMBER,ReservationDocumentHeader.ASSET_SUB_NUMBER,ReservationDocumentHeader.NETWORK_NUMBER_FOR_ACCT_ASSGMT,ReservationDocumentHeader.ISSUING_OR_RECEIVING_PLANT,ReservationDocumentHeader.ISSUING_OR_RECEIVING_STORAGE_LOC,ReservationDocumentHeader.TO_RESERVATION_DOCUMENT_ITEM]

All fields of the ReservationDocumentHeader entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ReservationDocumentHeader"

Technical entity name for ReservationDocumentHeader.

Static _keyFields

_keyFields: Array<Selectable<ReservationDocumentHeader>> = [ReservationDocumentHeader.RESERVATION]

All key fields of the ReservationDocumentHeader entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_RESERVATION_DOCUMENT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ReservationDocumentHeader>

    A builder that constructs instances of entity type ReservationDocumentHeader.

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

    Returns ReservationDocumentHeaderRequestBuilder

    A ReservationDocumentHeader request builder.