Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ServiceConfirmation" of service "API_SERVICE_CONFIRMATION_SRV". This service is part of the following communication scenarios: Service Confirmation Integration (SAP_COM_0352). See https://api.sap.com/api/API_SERVICE_CONFIRMATION_SRV for more information.

Hierarchy

  • Entity
    • ServiceConfirmation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ServiceConfirmation

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 billToParty

billToParty: string

Bill-To Party. The 32 digit GUID for the bill-to party. Maximum length: 10.

nullable

Optional contactPerson

contactPerson: string

Customer Contact Person. Maximum length: 10.

nullable

Optional customerPurchaseOrderDate

customerPurchaseOrderDate: Moment

Reference Document Date. Date which appears on the customer purchase order. For example, it can describe the day on which the customer created the purchase order.

nullable

Optional distributionChannel

distributionChannel: string

Distribution Channel. Channel through which the goods or services reach the customer. Typical examples of distribution channels are wholesale trade, retail trade, or direct sales. You can define data for business partners and products per sales organization and distribution channel. In a sales organization you can deliver to a specific customer through several distribution channels.You can assign a specific distribution channel as an attribute to one or more organizational units. These can be sales organizations or subordinate organizational units for a sales organization such as sales offices.If you work with a selection of sales offices from one sales organization, each of these sales offices can be responsible for a specific distribution channel (for example, wholesale trade, retail trade, direct sales). The attribute "distribution channel" is then assigned to each sales office.When determining the sales area, the system reads for which sales organization an office with a specific distribution channel is assigned and uses this to determine the combination of sales organization and distribution channel. Maximum length: 2.

nullable

Optional division

division: string

Division. Option of grouping products. A division can be used, for example, to display a specific product group. Maximum length: 2.

nullable

Optional language

language: string

Language Key of Description. Language in which the transaction short text was entered. Maximum length: 2.

nullable

Optional payerParty

payerParty: string

Payer. The 32-digit GUID that specifies the payer. Maximum length: 10.

nullable

Optional purchaseOrderByCustomer

purchaseOrderByCustomer: string

Sold-To Party's External Reference Number. Number used by the sold-to party to uniquely identify their sales document (such as an order). The number represents the connection between the order from the sold-to party and the sales document generated. Customers can use these numbers in correspondence to help determine specific document information. If a number is used for an order, then you can also print out this number on documents sent to customers (such as the delivery note). Maximum length: 35.

nullable

Optional referenceServiceOrder

referenceServiceOrder: string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional requestedServiceEndDateTime

requestedServiceEndDateTime: Moment

Service Request Due Date.

nullable

Optional requestedServiceStartDateTime

requestedServiceStartDateTime: Moment

Service Request Start Date.

nullable

Optional salesGroup

salesGroup: string

Sales Group. A group of sales people who are responsible for processing sales of certain products or services. By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record. Maximum length: 3.

nullable

Optional salesGroupOrgUnitId

salesGroupOrgUnitId: string

Sales Group. Group of sales employees, responsible for processing specific products or services. You can use purchasing groups to form different areas of responsibility in a sales office. Maximum length: 14.

nullable

Optional salesOffice

salesOffice: string

Sales Office. A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area. When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record. Maximum length: 4.

nullable

Optional salesOfficeOrgUnitId

salesOfficeOrgUnitId: string

Sales Office. Location (for example, branch office), that is responsible for specific sales and distribution products and services in a particular geographic area. You can form purchasing groups (for example, departments) in a sales office with specific sales responsibilities. Maximum length: 14.

nullable

Optional salesOrganization

salesOrganization: string

Sales Organization. An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims. You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 4.

nullable

Optional salesOrganizationOrgUnitId

salesOrganizationOrgUnitId: string

Sales Organization ID. Organizational unit responsible for specific products or services for sales and distribution. The responsibility of a sales organization can include legal liability for products and the customer's right of recourse. You can assign as many distribution channels and divisions as you want to a sales organization. A specific combination of sales organizations, distribution channels and divisions is known as a sales area. Maximum length: 14.

nullable

serviceConfirmation

serviceConfirmation: string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

Optional serviceConfirmationDescription

serviceConfirmationDescription: string

Transaction Description. Short description for a transaction. The description can be used during a search for the transaction. Maximum length: 40.

nullable

Optional serviceConfirmationIsCanceled

serviceConfirmationIsCanceled: string

Service Confirmation Is Canceled. Maximum length: 1.

nullable

Optional serviceConfirmationIsCompleted

serviceConfirmationIsCompleted: string

Service Confirmation Is Completed. Maximum length: 1.

nullable

Optional serviceConfirmationIsFinal

serviceConfirmationIsFinal: string

Final service confirmation for the related service order. Maximum length: 1.

nullable

Optional serviceConfirmationType

serviceConfirmationType: string

Business Transaction Type. Key that identifies a transaction type. A transaction type defines the characteristics and attributes of a business transaction (for example, sales order, service request, visit), and determines the controlling attributes (for example, text determination procedure, partner determination procedure, status profile, organizational data profile). A transaction type controls the processing of a specific business transaction. Maximum length: 4.

nullable

Optional serviceConfirmationUuid

serviceConfirmationUuid: string

GUID of a CRM Order Object. The unique ID for an operation is a technical key by which the operation can be uniquely identified. This key is only used internally, and the operation number is always displayed on the interface. However, the operation number is not necessarily unique.

nullable

Optional serviceDocumentPriority

serviceDocumentPriority: string

Activity Priority. Enter the priority of the document, for example, high or low. Maximum length: 1.

nullable

Optional serviceOrganization

serviceOrganization: string

Service Organization. Service organization for organizational management. Maximum length: 14.

nullable

Optional shipToParty

shipToParty: string

Ship-To Party. Specifies the ship-to party as a 32-digit GUID. Maximum length: 10.

nullable

Optional soldToParty

soldToParty: string

Sold-To Party. The 32-digit GUID used to identify the sold-to party. Maximum length: 10.

nullable

toItem

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

toPersonResponsible

toPersonResponsible: ServiceConfPersonResp[]

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

toPricingElement

toPricingElement: ServiceConfPriceElement[]

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

toReferenceObject

toReferenceObject: ServiceConfRefObject[]

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

toText

One-to-many navigation property to the ServiceConfirmationText 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<ServiceConfirmation> = new AllFields('*', ServiceConfirmation)

All fields selector.

Static BILL_TO_PARTY

BILL_TO_PARTY: StringField<ServiceConfirmation> = new StringField('BillToParty', ServiceConfirmation, 'Edm.String')

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

Static CONTACT_PERSON

CONTACT_PERSON: StringField<ServiceConfirmation> = new StringField('ContactPerson', ServiceConfirmation, '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_PURCHASE_ORDER_DATE

CUSTOMER_PURCHASE_ORDER_DATE: DateField<ServiceConfirmation> = new DateField('CustomerPurchaseOrderDate', ServiceConfirmation, 'Edm.DateTime')

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

Static DISTRIBUTION_CHANNEL

DISTRIBUTION_CHANNEL: StringField<ServiceConfirmation> = new StringField('DistributionChannel', ServiceConfirmation, 'Edm.String')

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

Static DIVISION

DIVISION: StringField<ServiceConfirmation> = new StringField('Division', ServiceConfirmation, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<ServiceConfirmation> = new StringField('Language', ServiceConfirmation, 'Edm.String')

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

Static PAYER_PARTY

PAYER_PARTY: StringField<ServiceConfirmation> = new StringField('PayerParty', ServiceConfirmation, 'Edm.String')

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

Static PURCHASE_ORDER_BY_CUSTOMER

PURCHASE_ORDER_BY_CUSTOMER: StringField<ServiceConfirmation> = new StringField('PurchaseOrderByCustomer', ServiceConfirmation, 'Edm.String')

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

Static REFERENCE_SERVICE_ORDER

REFERENCE_SERVICE_ORDER: StringField<ServiceConfirmation> = new StringField('ReferenceServiceOrder', ServiceConfirmation, 'Edm.String')

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

Static REQUESTED_SERVICE_END_DATE_TIME

REQUESTED_SERVICE_END_DATE_TIME: DateField<ServiceConfirmation> = new DateField('RequestedServiceEndDateTime', ServiceConfirmation, 'Edm.DateTimeOffset')

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

Static REQUESTED_SERVICE_START_DATE_TIME

REQUESTED_SERVICE_START_DATE_TIME: DateField<ServiceConfirmation> = new DateField('RequestedServiceStartDateTime', ServiceConfirmation, 'Edm.DateTimeOffset')

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

Static SALES_GROUP

SALES_GROUP: StringField<ServiceConfirmation> = new StringField('SalesGroup', ServiceConfirmation, 'Edm.String')

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

Static SALES_GROUP_ORG_UNIT_ID

SALES_GROUP_ORG_UNIT_ID: StringField<ServiceConfirmation> = new StringField('SalesGroupOrgUnitID', ServiceConfirmation, 'Edm.String')

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

Static SALES_OFFICE

SALES_OFFICE: StringField<ServiceConfirmation> = new StringField('SalesOffice', ServiceConfirmation, 'Edm.String')

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

Static SALES_OFFICE_ORG_UNIT_ID

SALES_OFFICE_ORG_UNIT_ID: StringField<ServiceConfirmation> = new StringField('SalesOfficeOrgUnitID', ServiceConfirmation, 'Edm.String')

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

Static SALES_ORGANIZATION

SALES_ORGANIZATION: StringField<ServiceConfirmation> = new StringField('SalesOrganization', ServiceConfirmation, 'Edm.String')

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

Static SALES_ORGANIZATION_ORG_UNIT_ID

SALES_ORGANIZATION_ORG_UNIT_ID: StringField<ServiceConfirmation> = new StringField('SalesOrganizationOrgUnitID', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION

SERVICE_CONFIRMATION: StringField<ServiceConfirmation> = new StringField('ServiceConfirmation', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_DESCRIPTION

SERVICE_CONFIRMATION_DESCRIPTION: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationDescription', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_IS_CANCELED

SERVICE_CONFIRMATION_IS_CANCELED: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationIsCanceled', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_IS_COMPLETED

SERVICE_CONFIRMATION_IS_COMPLETED: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationIsCompleted', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_IS_FINAL

SERVICE_CONFIRMATION_IS_FINAL: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationIsFinal', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_TYPE

SERVICE_CONFIRMATION_TYPE: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationType', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_CONFIRMATION_UUID

SERVICE_CONFIRMATION_UUID: StringField<ServiceConfirmation> = new StringField('ServiceConfirmationUUID', ServiceConfirmation, 'Edm.Guid')

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

Static SERVICE_DOCUMENT_PRIORITY

SERVICE_DOCUMENT_PRIORITY: StringField<ServiceConfirmation> = new StringField('ServiceDocumentPriority', ServiceConfirmation, 'Edm.String')

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

Static SERVICE_ORGANIZATION

SERVICE_ORGANIZATION: StringField<ServiceConfirmation> = new StringField('ServiceOrganization', ServiceConfirmation, 'Edm.String')

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

Static SHIP_TO_PARTY

SHIP_TO_PARTY: StringField<ServiceConfirmation> = new StringField('ShipToParty', ServiceConfirmation, 'Edm.String')

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

Static SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<ServiceConfirmation> = new StringField('SoldToParty', ServiceConfirmation, 'Edm.String')

Static representation of the soldToParty 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: Link<ServiceConfirmation, ServiceConfirmationItem> = new Link('to_Item', ServiceConfirmation, ServiceConfirmationItem)

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

Static TO_PERSON_RESPONSIBLE

TO_PERSON_RESPONSIBLE: Link<ServiceConfirmation, ServiceConfPersonResp> = new Link('to_PersonResponsible', ServiceConfirmation, ServiceConfPersonResp)

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

Static TO_PRICING_ELEMENT

TO_PRICING_ELEMENT: Link<ServiceConfirmation, ServiceConfPriceElement> = new Link('to_PricingElement', ServiceConfirmation, ServiceConfPriceElement)

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

Static TO_REFERENCE_OBJECT

TO_REFERENCE_OBJECT: Link<ServiceConfirmation, ServiceConfRefObject> = new Link('to_ReferenceObject', ServiceConfirmation, ServiceConfRefObject)

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

Static TO_TEXT

TO_TEXT: Link<ServiceConfirmation, ServiceConfirmationText> = new Link('to_Text', ServiceConfirmation, ServiceConfirmationText)

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

Static _allFields

_allFields: Array<StringField<ServiceConfirmation> | DateField<ServiceConfirmation> | Link<ServiceConfirmation, ServiceConfirmationItem> | Link<ServiceConfirmation, ServiceConfPersonResp> | Link<ServiceConfirmation, ServiceConfPriceElement> | Link<ServiceConfirmation, ServiceConfRefObject> | Link<ServiceConfirmation, ServiceConfirmationText>> = [ServiceConfirmation.SERVICE_CONFIRMATION,ServiceConfirmation.SERVICE_CONFIRMATION_TYPE,ServiceConfirmation.SERVICE_CONFIRMATION_UUID,ServiceConfirmation.SERVICE_CONFIRMATION_DESCRIPTION,ServiceConfirmation.LANGUAGE,ServiceConfirmation.SERVICE_DOCUMENT_PRIORITY,ServiceConfirmation.REQUESTED_SERVICE_START_DATE_TIME,ServiceConfirmation.REQUESTED_SERVICE_END_DATE_TIME,ServiceConfirmation.PURCHASE_ORDER_BY_CUSTOMER,ServiceConfirmation.CUSTOMER_PURCHASE_ORDER_DATE,ServiceConfirmation.SERVICE_CONFIRMATION_IS_COMPLETED,ServiceConfirmation.SERVICE_CONFIRMATION_IS_CANCELED,ServiceConfirmation.SALES_ORGANIZATION,ServiceConfirmation.DISTRIBUTION_CHANNEL,ServiceConfirmation.DIVISION,ServiceConfirmation.SALES_OFFICE,ServiceConfirmation.SALES_GROUP,ServiceConfirmation.SOLD_TO_PARTY,ServiceConfirmation.SHIP_TO_PARTY,ServiceConfirmation.BILL_TO_PARTY,ServiceConfirmation.PAYER_PARTY,ServiceConfirmation.CONTACT_PERSON,ServiceConfirmation.REFERENCE_SERVICE_ORDER,ServiceConfirmation.SERVICE_CONFIRMATION_IS_FINAL,ServiceConfirmation.SALES_ORGANIZATION_ORG_UNIT_ID,ServiceConfirmation.SERVICE_ORGANIZATION,ServiceConfirmation.SALES_OFFICE_ORG_UNIT_ID,ServiceConfirmation.SALES_GROUP_ORG_UNIT_ID,ServiceConfirmation.TO_ITEM,ServiceConfirmation.TO_PERSON_RESPONSIBLE,ServiceConfirmation.TO_PRICING_ELEMENT,ServiceConfirmation.TO_REFERENCE_OBJECT,ServiceConfirmation.TO_TEXT]

All fields of the ServiceConfirmation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ServiceConfirmation"

Technical entity name for ServiceConfirmation.

Static _keyFields

_keyFields: Array<Selectable<ServiceConfirmation>> = [ServiceConfirmation.SERVICE_CONFIRMATION]

All key fields of the ServiceConfirmation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SERVICE_CONFIRMATION_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ServiceConfirmation>

    A builder that constructs instances of entity type ServiceConfirmation.

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

    Returns ServiceConfirmationRequestBuilder

    A ServiceConfirmation request builder.