Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ServiceEntrySheetItem" of service "API_SERVICE_ENTRY_SHEET_SRV". This service is part of the following communication scenarios: Service Entry Sheet Integration (SAP_COM_0146). See https://api.sap.com/api/API_SERVICE_ENTRY_SHEET_SRV for more information.

Hierarchy

  • Entity
    • ServiceEntrySheetItem

Implements

Index

Constructors

Properties

Accessors

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 accountAssignmentCategory

accountAssignmentCategory: undefined | string

Account Assignment Category. Specifies whether accounting for an item is to be effected via an auxiliary account (such as a cost center). The account assignment category determines which account assignment data (such as cost center, account number and so on) is necessary for the item. Maximum length: 1.

nullable

Optional confirmedQuantity

confirmedQuantity: BigNumber

Stated Quantity.

nullable

Optional createdByUser

createdByUser: undefined | string

Created By (User Name) for Service Entry Sheet. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional currency

currency: undefined | string

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

nullable

Optional isDeleted

isDeleted: undefined | string

Deletion indicator in purchasing document. Determines whether the item in the purchasing document is deleted or blocked. You can set the deletion indicator by choosing Edit -> Delete if:You want to cancel an itemAn item is closed and can be archivedYou can set the blocking indicator by selecting the item and then choosing Edit -> Block if you do not want to allow subsequent functions for the item. Note that you must manually remove the indicator as soon as subsequent functions are allowed again.You have entered a purchase order item by mistake. You cancel it by setting the deletion indicator.A purchase order item has been delivered, invoiced, and paid for, and can now be archived. You can set the deletion indicator. Maximum length: 1.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed (User Name) for Service Entry Sheet. Maximum length: 12.

nullable

Optional materialGroup

materialGroup: undefined | string

Product Group. Key that you use to group together several products or services with the same attributes, and to assign them to a particular product group. You can use product groups to:Restrict the scope of analysesSearch specifically for product master records via search helpsIf you have not defined a product group hierarchy using the classification system, you maintain product groups in Customizing for the Material Master in Define material groups.If you have defined a product group hierarchy, which is normally the case in retail, you maintain product groups in Customizing for Material Groups or from the initial Retailing screen by choosing Master data -> Material group. Maximum length: 9.

nullable

Optional multipleAcctAssgmtDistribution

multipleAcctAssgmtDistribution: undefined | string

Distribution Indicator for Multiple Account Assignment. Defines how the quantity and value of the purchase order item are distributed to individual account assignment items. You can distribute the purchase order quantity or the net value of a document item, or specify a percentage for each account assignment. The system calculates complementary values. For example, if you choose quantity-based distribution and enter a number of pieces for each account assignment, the system calculates the percentage and net value.If you choose quantity-based or percentage distribution, the quantities that are distributed to an account assignment are rounded to three decimal places, to ensure that the 100% of the item quantity is always distributed.If you choose percentage distribution and change the requested quantity on the item overview screen, the system adjusts the quantities in the associated account assignment items.If you choose amount-based distribution, the system distributes the item quantity to the individual account assignments exactly according to the defined distribution, including very small value amounts. The quantities of individual account assignment items are displayed as rounded, but the system uses the exact quantities. Maximum length: 1.

nullable

Optional netAmount

netAmount: BigNumber

Stated Amount.

nullable

Optional netPriceAmount

netPriceAmount: BigNumber

Price per Unit for an SES Item.

nullable

Optional originObject

originObject: undefined | string

External Reference Document. Maximum length: 12.

nullable

Optional plant

plant: undefined | string

Plant. Specifies the key for a production facility or branch office within the company (that is, the company code). You use the plant key to determine, for instance, which plant is to receive ordered goods. Maximum length: 4.

nullable

Optional purchaseContract

purchaseContract: undefined | string

Purchase Contract for Enhanced Limit. Identifies the purchase contract for the enhanced limit. The contract for the enhanced limit enables the following process:In a purchase contract, you define potential services for a service provider.In the purchase order item, you define a limit (Overall Limit and Expected Value) and you assign the purchase contract to this limit.In the service entry sheet that refers to this limit item, the purchaser can only select services from the assigned contract. Maximum length: 10.

nullable

Optional purchaseContractItem

purchaseContractItem: undefined | string

Purchase Contract Item. Specifies the number of the outline agreement item to which this purchase order or purchase requisition refers. Maximum length: 5.

nullable

Optional purchaseOrder

purchaseOrder: undefined | string

Reference Purchase Order. Maximum length: 10.

nullable

Optional purchaseOrderItem

purchaseOrderItem: undefined | string

Referenced Purchase Order Item. Maximum length: 5.

nullable

Optional purchasingGroup

purchasingGroup: undefined | string

Purchasing Group. Key for a buyer or a group of buyers, who is/are responsible for certain purchasing activities. Frequently, purchasing documents (such as purchase orders) are monitored by the purchasing group. Urging letters (in the case of overdue deliveries) fall also within the group's scope of activities.For each purchasing group, statistical analyses can be performed. The purchasing group can be used as a sort criterion when creating purchasing-specific reports. Maximum length: 3.

nullable

Optional purchasingOrganization

purchasingOrganization: undefined | string

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

nullable

Optional purgDocItemExternalReference

purgDocItemExternalReference: undefined | string

External Reference ID. Represents the node of an external document or of a subordinate entity. The ID can refer, for example, to the external document, to the item, or to the condition line of the external document. In any case, the ID must be unique. Maximum length: 70.

nullable

Optional quantityUnit

quantityUnit: undefined | string

Unit of Measure for Service Entry Statement. 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

Optional service

service: undefined | string

Product. Maximum length: 40.

nullable

serviceEntrySheet

serviceEntrySheet: string

Service Entry Sheet. Maximum length: 10.

serviceEntrySheetItem

serviceEntrySheetItem: string

Item Number of Service Entry Sheet. Maximum length: 5.

Optional serviceEntrySheetItemDesc

serviceEntrySheetItemDesc: undefined | string

Item Description for Service Entry Sheet. Maximum length: 40.

nullable

Optional serviceEntrySheetItemUuid

serviceEntrySheetItemUuid: undefined | string

UUID serving as key (parent key, root key).

nullable

Optional serviceEntrySheetUuid

serviceEntrySheetUuid: undefined | string

UUID serving as key (parent key, root key).

nullable

Optional servicePerformanceDate

servicePerformanceDate: Moment

Date of Service Performance.

nullable

Optional servicePerformer

servicePerformer: undefined | string

Service Performer. Maximum length: 10.

nullable

toAccountAssignment

toAccountAssignment: SrvcEntrShtAcctAssignment[]

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

Optional workItem

workItem: undefined | string

Work Item ID. Maximum length: 10.

nullable

Static ACCOUNT_ASSIGNMENT_CATEGORY

ACCOUNT_ASSIGNMENT_CATEGORY: StringField<ServiceEntrySheetItem> = new StringField('AccountAssignmentCategory', ServiceEntrySheetItem, 'Edm.String')

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

Static ALL_FIELDS

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

All fields selector.

Static CONFIRMED_QUANTITY

CONFIRMED_QUANTITY: BigNumberField<ServiceEntrySheetItem> = new BigNumberField('ConfirmedQuantity', ServiceEntrySheetItem, 'Edm.Decimal')

Static representation of the confirmedQuantity 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<ServiceEntrySheetItem> = new StringField('CreatedByUser', ServiceEntrySheetItem, '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_TIME

CREATION_DATE_TIME: DateField<ServiceEntrySheetItem> = new DateField('CreationDateTime', ServiceEntrySheetItem, 'Edm.DateTimeOffset')

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

Static CURRENCY

CURRENCY: StringField<ServiceEntrySheetItem> = new StringField('Currency', ServiceEntrySheetItem, 'Edm.String')

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

Static IS_DELETED

IS_DELETED: StringField<ServiceEntrySheetItem> = new StringField('IsDeleted', ServiceEntrySheetItem, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<ServiceEntrySheetItem> = new StringField('LastChangedByUser', ServiceEntrySheetItem, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<ServiceEntrySheetItem> = new DateField('LastChangeDateTime', ServiceEntrySheetItem, 'Edm.DateTimeOffset')

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

Static MATERIAL_GROUP

MATERIAL_GROUP: StringField<ServiceEntrySheetItem> = new StringField('MaterialGroup', ServiceEntrySheetItem, 'Edm.String')

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

Static MULTIPLE_ACCT_ASSGMT_DISTRIBUTION

MULTIPLE_ACCT_ASSGMT_DISTRIBUTION: StringField<ServiceEntrySheetItem> = new StringField('MultipleAcctAssgmtDistribution', ServiceEntrySheetItem, 'Edm.String')

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

Static NET_AMOUNT

NET_AMOUNT: BigNumberField<ServiceEntrySheetItem> = new BigNumberField('NetAmount', ServiceEntrySheetItem, 'Edm.Decimal')

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

Static NET_PRICE_AMOUNT

NET_PRICE_AMOUNT: BigNumberField<ServiceEntrySheetItem> = new BigNumberField('NetPriceAmount', ServiceEntrySheetItem, 'Edm.Decimal')

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

Static ORIGIN_OBJECT

ORIGIN_OBJECT: StringField<ServiceEntrySheetItem> = new StringField('OriginObject', ServiceEntrySheetItem, 'Edm.String')

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

Static PLANT

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

PURCHASE_CONTRACT: StringField<ServiceEntrySheetItem> = new StringField('PurchaseContract', ServiceEntrySheetItem, 'Edm.String')

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

Static PURCHASE_CONTRACT_ITEM

PURCHASE_CONTRACT_ITEM: StringField<ServiceEntrySheetItem> = new StringField('PurchaseContractItem', ServiceEntrySheetItem, 'Edm.String')

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

Static PURCHASE_ORDER

PURCHASE_ORDER: StringField<ServiceEntrySheetItem> = new StringField('PurchaseOrder', ServiceEntrySheetItem, 'Edm.String')

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

Static PURCHASE_ORDER_ITEM

PURCHASE_ORDER_ITEM: StringField<ServiceEntrySheetItem> = new StringField('PurchaseOrderItem', ServiceEntrySheetItem, 'Edm.String')

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

Static PURCHASING_GROUP

PURCHASING_GROUP: StringField<ServiceEntrySheetItem> = new StringField('PurchasingGroup', ServiceEntrySheetItem, 'Edm.String')

Static representation of the purchasingGroup 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<ServiceEntrySheetItem> = new StringField('PurchasingOrganization', ServiceEntrySheetItem, '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 PURG_DOC_ITEM_EXTERNAL_REFERENCE

PURG_DOC_ITEM_EXTERNAL_REFERENCE: StringField<ServiceEntrySheetItem> = new StringField('PurgDocItemExternalReference', ServiceEntrySheetItem, 'Edm.String')

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

Static QUANTITY_UNIT

QUANTITY_UNIT: StringField<ServiceEntrySheetItem> = new StringField('QuantityUnit', ServiceEntrySheetItem, 'Edm.String')

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

Static SERVICE

SERVICE: StringField<ServiceEntrySheetItem> = new StringField('Service', ServiceEntrySheetItem, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET

SERVICE_ENTRY_SHEET: StringField<ServiceEntrySheetItem> = new StringField('ServiceEntrySheet', ServiceEntrySheetItem, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_ITEM

SERVICE_ENTRY_SHEET_ITEM: StringField<ServiceEntrySheetItem> = new StringField('ServiceEntrySheetItem', ServiceEntrySheetItem, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_ITEM_DESC

SERVICE_ENTRY_SHEET_ITEM_DESC: StringField<ServiceEntrySheetItem> = new StringField('ServiceEntrySheetItemDesc', ServiceEntrySheetItem, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_ITEM_UUID

SERVICE_ENTRY_SHEET_ITEM_UUID: StringField<ServiceEntrySheetItem> = new StringField('ServiceEntrySheetItemUUID', ServiceEntrySheetItem, 'Edm.Guid')

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

Static SERVICE_ENTRY_SHEET_UUID

SERVICE_ENTRY_SHEET_UUID: StringField<ServiceEntrySheetItem> = new StringField('ServiceEntrySheetUUID', ServiceEntrySheetItem, 'Edm.Guid')

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

Static SERVICE_PERFORMANCE_DATE

SERVICE_PERFORMANCE_DATE: DateField<ServiceEntrySheetItem> = new DateField('ServicePerformanceDate', ServiceEntrySheetItem, 'Edm.DateTime')

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

Static SERVICE_PERFORMER

SERVICE_PERFORMER: StringField<ServiceEntrySheetItem> = new StringField('ServicePerformer', ServiceEntrySheetItem, 'Edm.String')

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

Static TO_ACCOUNT_ASSIGNMENT

TO_ACCOUNT_ASSIGNMENT: Link<ServiceEntrySheetItem, SrvcEntrShtAcctAssignment> = new Link('to_AccountAssignment', ServiceEntrySheetItem, SrvcEntrShtAcctAssignment)

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

Static WORK_ITEM

WORK_ITEM: StringField<ServiceEntrySheetItem> = new StringField('WorkItem', ServiceEntrySheetItem, 'Edm.String')

Static representation of the workItem 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<ServiceEntrySheetItem> | BigNumberField<ServiceEntrySheetItem> | DateField<ServiceEntrySheetItem> | Link<ServiceEntrySheetItem, SrvcEntrShtAcctAssignment>> = [ServiceEntrySheetItem.SERVICE_ENTRY_SHEET,ServiceEntrySheetItem.SERVICE_ENTRY_SHEET_ITEM,ServiceEntrySheetItem.ACCOUNT_ASSIGNMENT_CATEGORY,ServiceEntrySheetItem.CONFIRMED_QUANTITY,ServiceEntrySheetItem.CREATED_BY_USER,ServiceEntrySheetItem.CREATION_DATE_TIME,ServiceEntrySheetItem.PURCHASING_ORGANIZATION,ServiceEntrySheetItem.PURCHASING_GROUP,ServiceEntrySheetItem.PLANT,ServiceEntrySheetItem.CURRENCY,ServiceEntrySheetItem.IS_DELETED,ServiceEntrySheetItem.LAST_CHANGE_DATE_TIME,ServiceEntrySheetItem.LAST_CHANGED_BY_USER,ServiceEntrySheetItem.MATERIAL_GROUP,ServiceEntrySheetItem.MULTIPLE_ACCT_ASSGMT_DISTRIBUTION,ServiceEntrySheetItem.NET_AMOUNT,ServiceEntrySheetItem.NET_PRICE_AMOUNT,ServiceEntrySheetItem.ORIGIN_OBJECT,ServiceEntrySheetItem.PURCHASE_ORDER,ServiceEntrySheetItem.PURCHASE_ORDER_ITEM,ServiceEntrySheetItem.PURCHASE_CONTRACT,ServiceEntrySheetItem.PURCHASE_CONTRACT_ITEM,ServiceEntrySheetItem.QUANTITY_UNIT,ServiceEntrySheetItem.SERVICE,ServiceEntrySheetItem.SERVICE_ENTRY_SHEET_ITEM_DESC,ServiceEntrySheetItem.SERVICE_ENTRY_SHEET_ITEM_UUID,ServiceEntrySheetItem.SERVICE_ENTRY_SHEET_UUID,ServiceEntrySheetItem.SERVICE_PERFORMANCE_DATE,ServiceEntrySheetItem.SERVICE_PERFORMER,ServiceEntrySheetItem.WORK_ITEM,ServiceEntrySheetItem.PURG_DOC_ITEM_EXTERNAL_REFERENCE,ServiceEntrySheetItem.TO_ACCOUNT_ASSIGNMENT]

All fields of the ServiceEntrySheetItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ServiceEntrySheetItem"

Technical entity name for ServiceEntrySheetItem.

Static _keyFields

_keyFields: Array<Selectable<ServiceEntrySheetItem>> = [ServiceEntrySheetItem.SERVICE_ENTRY_SHEET, ServiceEntrySheetItem.SERVICE_ENTRY_SHEET_ITEM]

All key fields of the ServiceEntrySheetItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SERVICE_ENTRY_SHEET_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ServiceEntrySheetItem>

    A builder that constructs instances of entity type ServiceEntrySheetItem.

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

    Returns ServiceEntrySheetItemRequestBuilder

    A ServiceEntrySheetItem request builder.