Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ReservationDocumentItem" 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
    • ReservationDocumentItem

Implements

Index

Constructors

Properties

Methods

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 baseUnit

baseUnit: string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional batch

batch: string

Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.

nullable

Optional companyCodeCurrency

companyCodeCurrency: string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional debitCreditCode

debitCreditCode: string

Debit/Credit Indicator. Shows on which side of the account (S = debit, H = credit) the transaction figures are updated. Maximum length: 1.

nullable

Optional entryUnit

entryUnit: string

Unit of Entry. Specifies the unit of measure in which the goods movement or inventory count is entered. Enter a unit of measure here only if it differs from the default unit of measure.There are the following default units of measure:the order unit for goods receipts with reference to purchase ordersthe production unit for goods receipts with reference to production ordersthe unit of issue for other goods movementsIf the default unit of measure has not been defined in the material master record, the system will suggest the stockkeeping unit. Maximum length: 3.

nullable

Optional glAccount

glAccount: string

G/L Account Number. The G/L account number identifies the G/L account in a chart of accounts. Maximum length: 10.

nullable

Optional goodsMovementIsAllowed

goodsMovementIsAllowed: boolean

Goods Movement for Reservation Allowed. Specifies that goods movements are allowed for the reservation item.

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 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 manufacturingOrderOperation

manufacturingOrderOperation: string

Operation/Activity Number. Production Planning Determines in which order the operations of a sequence are carried out. Maximum length: 4.

nullable

Optional matlCompRequirementDate

matlCompRequirementDate: Moment

Requirement Date for the Component. Specifies the date on which the requested quantity of material is required.

nullable

Optional plant

plant: string

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

nullable

Optional product

product: string

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

nullable

Optional purchasingDocument

purchasingDocument: string

Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional purchasingDocumentItem

purchasingDocumentItem: string

Item Number of Purchasing Document. Specifies the number that uniquely identifies an item in . Maximum length: 5.

nullable

Optional quantityIsFixed

quantityIsFixed: boolean

Quantity is Fixed. Determines that the quantity of an item is constant. Set this indicator if the quantity in a relational system does not change.If an item of a BOM is marked as being fixed and the quantity of the finished product to be manufactured is changed, the quantity of this item does not change.If a "materials to be provided" item is not marked as being fixed, and the quantity of the subcontracted item is changed, the quantity of the material to be provided to the subcontractor changes proportionately.

nullable

recordType

recordType: string

Record type. Maximum length: 1.

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

Optional requirementType

requirementType: string

Requirement type. Determines the way in which the system handles requirements planning. You can use the requirement type to control, for example, lot sizing, inventory management, and storage costs. When you create a sales order, for example, you can specify a requirement type for each schedule line. During sales order and delivery processing, the requirement type, in combination with the planning type controls whether the systemGenerates requirementsChecks availabilityThe schedule line category determines the requirements type. You cannot change the requirements type during sales order processing. Maximum length: 2.

nullable

reservation

reservation: string

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

reservationItem

reservationItem: string

Item Number of Reservation/Dependent Requirement. Specifies the number that uniquely identifies an item in . Maximum length: 4.

Optional reservationItemIsFinallyIssued

reservationItemIsFinallyIssued: boolean

Final Issue for Reservation. Indicates that a reservation item is completed. Further goods movements in respect of this reservation item are not anticipated, although they are still possible.The indicator is set automatically for a goods movement when the total reserved quantity has been withdrawn or delivered. In the case of a partial delivery, you can manually set the indicator if no further goods movements are expected in respect of the relevant reservation item.

nullable

Optional reservationItemText

reservationItemText: string

Item Text. Contains an explanatory text on the line item. Line item texts can be used internally and externally. To be able to distinguish between these, you must begin texts for external use with "*". These texts can then be printed on all correspondence, dunning notices, payment advice notes, etc. The asterisk is removed when the text is printed.This function is only available in the FI component. It cannot be used in Materials Management. Maximum length: 50.

nullable

Optional reservationItmIsMarkedForDeltn

reservationItmIsMarkedForDeltn: boolean

Item is Deleted. Specifies whether the item has already been deleted.

nullable

Optional resvnItmRequiredQtyInBaseUnit

resvnItmRequiredQtyInBaseUnit: BigNumber

Requirement Quantity. Specifies the quantity in the base unit of measure, which can have various meanings, depending on the situation: In the case of a planned order or a production order, this is the quantity of the material component required to manufacture the planned order quantity.In the case of a reservation, this is the quantity reserved.

nullable

Optional resvnItmRequiredQtyInEntryUnit

resvnItmRequiredQtyInEntryUnit: BigNumber

Quantity in Unit of Entry. Specifies the quantity to be moved in the unit of entry. The quantity is automatically converted to the stockkeeping unit (base unit of measure). Enter the quantity to be moved in any unit of measure for the material.If the relevant unit of measure has not been defined in the material master record, the system uses the stockkeeping unit.If you do not enter a unit of measure, the system uses the following units of measure:order unit in goods receipts against purchase ordersproduction unit in goods receipts against production ordersunit of issue in other goods movements.

nullable

Optional resvnItmWithdrawnAmtInCcCrcy

resvnItmWithdrawnAmtInCcCrcy: BigNumber

Value Withdrawn. Indicates the value of the quantity withdrawn from storage.

nullable

Optional resvnItmWithdrawnQtyInBaseUnit

resvnItmWithdrawnQtyInBaseUnit: BigNumber

Quantity Withdrawn. Specifies the quantity already withdrawn.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.

nullable

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

Optional unloadingPointName

unloadingPointName: string

Unloading Point. Specifies the point at which the material is to be unloaded (for example, ramp 1). Maximum length: 25.

nullable

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

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<ReservationDocumentItem> = new StringField('BaseUnit', ReservationDocumentItem, 'Edm.String')

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

Static BATCH

BATCH: StringField<ReservationDocumentItem> = new StringField('Batch', ReservationDocumentItem, 'Edm.String')

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

Static COMPANY_CODE_CURRENCY

COMPANY_CODE_CURRENCY: StringField<ReservationDocumentItem> = new StringField('CompanyCodeCurrency', ReservationDocumentItem, 'Edm.String')

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

Static DEBIT_CREDIT_CODE

DEBIT_CREDIT_CODE: StringField<ReservationDocumentItem> = new StringField('DebitCreditCode', ReservationDocumentItem, 'Edm.String')

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

Static ENTRY_UNIT

ENTRY_UNIT: StringField<ReservationDocumentItem> = new StringField('EntryUnit', ReservationDocumentItem, 'Edm.String')

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

Static GL_ACCOUNT

GL_ACCOUNT: StringField<ReservationDocumentItem> = new StringField('GLAccount', ReservationDocumentItem, 'Edm.String')

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

Static GOODS_MOVEMENT_IS_ALLOWED

GOODS_MOVEMENT_IS_ALLOWED: BooleanField<ReservationDocumentItem> = new BooleanField('GoodsMovementIsAllowed', ReservationDocumentItem, 'Edm.Boolean')

Static representation of the goodsMovementIsAllowed 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<ReservationDocumentItem> = new StringField('GoodsMovementType', ReservationDocumentItem, '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<ReservationDocumentItem> = new StringField('GoodsRecipientName', ReservationDocumentItem, '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<ReservationDocumentItem> = new StringField('IssuingOrReceivingPlant', ReservationDocumentItem, '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<ReservationDocumentItem> = new StringField('IssuingOrReceivingStorageLoc', ReservationDocumentItem, '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 MANUFACTURING_ORDER_OPERATION

MANUFACTURING_ORDER_OPERATION: StringField<ReservationDocumentItem> = new StringField('ManufacturingOrderOperation', ReservationDocumentItem, 'Edm.String')

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

Static MATL_COMP_REQUIREMENT_DATE

MATL_COMP_REQUIREMENT_DATE: DateField<ReservationDocumentItem> = new DateField('MatlCompRequirementDate', ReservationDocumentItem, 'Edm.DateTime')

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

Static PLANT

PLANT: StringField<ReservationDocumentItem> = new StringField('Plant', ReservationDocumentItem, '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<ReservationDocumentItem> = new StringField('Product', ReservationDocumentItem, '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 PURCHASING_DOCUMENT

PURCHASING_DOCUMENT: StringField<ReservationDocumentItem> = new StringField('PurchasingDocument', ReservationDocumentItem, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM

PURCHASING_DOCUMENT_ITEM: StringField<ReservationDocumentItem> = new StringField('PurchasingDocumentItem', ReservationDocumentItem, 'Edm.String')

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

Static QUANTITY_IS_FIXED

QUANTITY_IS_FIXED: BooleanField<ReservationDocumentItem> = new BooleanField('QuantityIsFixed', ReservationDocumentItem, 'Edm.Boolean')

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

Static RECORD_TYPE

RECORD_TYPE: StringField<ReservationDocumentItem> = new StringField('RecordType', ReservationDocumentItem, 'Edm.String')

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

Static REQUIREMENT_TYPE

REQUIREMENT_TYPE: StringField<ReservationDocumentItem> = new StringField('RequirementType', ReservationDocumentItem, 'Edm.String')

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

Static RESERVATION

RESERVATION: StringField<ReservationDocumentItem> = new StringField('Reservation', ReservationDocumentItem, '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_ITEM

RESERVATION_ITEM: StringField<ReservationDocumentItem> = new StringField('ReservationItem', ReservationDocumentItem, 'Edm.String')

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

Static RESERVATION_ITEM_IS_FINALLY_ISSUED

RESERVATION_ITEM_IS_FINALLY_ISSUED: BooleanField<ReservationDocumentItem> = new BooleanField('ReservationItemIsFinallyIssued', ReservationDocumentItem, 'Edm.Boolean')

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

Static RESERVATION_ITEM_TEXT

RESERVATION_ITEM_TEXT: StringField<ReservationDocumentItem> = new StringField('ReservationItemText', ReservationDocumentItem, 'Edm.String')

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

Static RESERVATION_ITM_IS_MARKED_FOR_DELTN

RESERVATION_ITM_IS_MARKED_FOR_DELTN: BooleanField<ReservationDocumentItem> = new BooleanField('ReservationItmIsMarkedForDeltn', ReservationDocumentItem, 'Edm.Boolean')

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

Static RESVN_ITM_REQUIRED_QTY_IN_BASE_UNIT

RESVN_ITM_REQUIRED_QTY_IN_BASE_UNIT: BigNumberField<ReservationDocumentItem> = new BigNumberField('ResvnItmRequiredQtyInBaseUnit', ReservationDocumentItem, 'Edm.Decimal')

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

Static RESVN_ITM_REQUIRED_QTY_IN_ENTRY_UNIT

RESVN_ITM_REQUIRED_QTY_IN_ENTRY_UNIT: BigNumberField<ReservationDocumentItem> = new BigNumberField('ResvnItmRequiredQtyInEntryUnit', ReservationDocumentItem, 'Edm.Decimal')

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

Static RESVN_ITM_WITHDRAWN_AMT_IN_CC_CRCY

RESVN_ITM_WITHDRAWN_AMT_IN_CC_CRCY: BigNumberField<ReservationDocumentItem> = new BigNumberField('ResvnItmWithdrawnAmtInCCCrcy', ReservationDocumentItem, 'Edm.Decimal')

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

Static RESVN_ITM_WITHDRAWN_QTY_IN_BASE_UNIT

RESVN_ITM_WITHDRAWN_QTY_IN_BASE_UNIT: BigNumberField<ReservationDocumentItem> = new BigNumberField('ResvnItmWithdrawnQtyInBaseUnit', ReservationDocumentItem, 'Edm.Decimal')

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

Static STORAGE_LOCATION

STORAGE_LOCATION: StringField<ReservationDocumentItem> = new StringField('StorageLocation', ReservationDocumentItem, 'Edm.String')

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

Static SUPPLIER

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

UNLOADING_POINT_NAME: StringField<ReservationDocumentItem> = new StringField('UnloadingPointName', ReservationDocumentItem, 'Edm.String')

Static representation of the unloadingPointName 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<ReservationDocumentItem> | DateField<ReservationDocumentItem> | BooleanField<ReservationDocumentItem> | BigNumberField<ReservationDocumentItem>> = [ReservationDocumentItem.RESERVATION,ReservationDocumentItem.RESERVATION_ITEM,ReservationDocumentItem.RECORD_TYPE,ReservationDocumentItem.PRODUCT,ReservationDocumentItem.REQUIREMENT_TYPE,ReservationDocumentItem.MATL_COMP_REQUIREMENT_DATE,ReservationDocumentItem.PLANT,ReservationDocumentItem.MANUFACTURING_ORDER_OPERATION,ReservationDocumentItem.GOODS_MOVEMENT_IS_ALLOWED,ReservationDocumentItem.STORAGE_LOCATION,ReservationDocumentItem.BATCH,ReservationDocumentItem.DEBIT_CREDIT_CODE,ReservationDocumentItem.BASE_UNIT,ReservationDocumentItem.GL_ACCOUNT,ReservationDocumentItem.GOODS_MOVEMENT_TYPE,ReservationDocumentItem.ENTRY_UNIT,ReservationDocumentItem.QUANTITY_IS_FIXED,ReservationDocumentItem.COMPANY_CODE_CURRENCY,ReservationDocumentItem.ISSUING_OR_RECEIVING_PLANT,ReservationDocumentItem.ISSUING_OR_RECEIVING_STORAGE_LOC,ReservationDocumentItem.PURCHASING_DOCUMENT,ReservationDocumentItem.PURCHASING_DOCUMENT_ITEM,ReservationDocumentItem.SUPPLIER,ReservationDocumentItem.RESVN_ITM_REQUIRED_QTY_IN_BASE_UNIT,ReservationDocumentItem.RESERVATION_ITEM_IS_FINALLY_ISSUED,ReservationDocumentItem.RESERVATION_ITM_IS_MARKED_FOR_DELTN,ReservationDocumentItem.RESVN_ITM_REQUIRED_QTY_IN_ENTRY_UNIT,ReservationDocumentItem.RESVN_ITM_WITHDRAWN_QTY_IN_BASE_UNIT,ReservationDocumentItem.RESVN_ITM_WITHDRAWN_AMT_IN_CC_CRCY,ReservationDocumentItem.GOODS_RECIPIENT_NAME,ReservationDocumentItem.UNLOADING_POINT_NAME,ReservationDocumentItem.RESERVATION_ITEM_TEXT]

All fields of the ReservationDocumentItem 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_ReservationDocumentItem"

Technical entity name for ReservationDocumentItem.

Static _keyFields

_keyFields: Array<Selectable<ReservationDocumentItem>> = [ReservationDocumentItem.RESERVATION, ReservationDocumentItem.RESERVATION_ITEM, ReservationDocumentItem.RECORD_TYPE]

All key fields of the ReservationDocumentItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_RESERVATION_DOCUMENT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ReservationDocumentItem>

    A builder that constructs instances of entity type ReservationDocumentItem.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns ReservationDocumentItemRequestBuilder

    A ReservationDocumentItem request builder.