Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_KanbanContainer" of service "API_KANBAN_CONTROL_CYCLE_SRV". This service is part of the following communication scenarios: Kanban Control Cycle Integration (SAP_COM_0330). See https://api.sap.com/api/API_KANBAN_CONTROL_CYCLE_SRV;v=0002 for more information.

Hierarchy

  • Entity
    • KanbanContainer

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns KanbanContainer

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 actualQuantityInBaseUnit

actualQuantityInBaseUnit: BigNumber

Actual Quantity in Base Unit.

nullable

Optional backflushReportingPoint

backflushReportingPoint: undefined | string

Reporting Point. Maximum length: 4.

nullable

Optional baseUnit

baseUnit: undefined | string

Base Unit of Measure. Maximum length: 3.

nullable

Optional changedPackgInstrnDataIsAvail

changedPackgInstrnDataIsAvail: undefined | false | true

Indicator for Changed Packing Instruction Data.

nullable

Optional internalJitCallNumber

internalJitCallNumber: undefined | string

JIT Call. Maximum length: 10.

nullable

Optional isDeleted

isDeleted: undefined | false | true

Deletion Indicator.

nullable

Optional isLocked

isLocked: undefined | false | true

Lock Indicator.

nullable

Optional jitCallItemNumber

jitCallItemNumber: undefined | string

JIT Call Item. Maximum length: 4.

nullable

kanbanContainer

kanbanContainer: string

Kanban Container. Maximum length: 10.

Optional kanbanContainerStatus

kanbanContainerStatus: undefined | string

Kanban Container Status. Maximum length: 1.

nullable

Optional kanbanControlCycle

kanbanControlCycle: undefined | string

Kanban Control Cycle. Maximum length: 7.

nullable

Optional kanbanControlCycleItem

kanbanControlCycleItem: undefined | string

Kanban Control Cycle Item. Maximum length: 3.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Date and Time of Last Change.

nullable

Optional lastChangeTime

lastChangeTime: Time

Time of Last Change.

nullable

Optional materialDocument

materialDocument: undefined | string

Material Document. Maximum length: 10.

nullable

Optional materialDocumentItem

materialDocumentItem: undefined | string

Material Document Item. Maximum length: 4.

nullable

Optional materialDocumentYear

materialDocumentYear: undefined | string

Material Document Year. Maximum length: 4.

nullable

Optional orderId

orderId: undefined | string

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

nullable

Optional plannedOrder

plannedOrder: undefined | string

Planned Order. Maximum length: 10.

nullable

Optional plannedReceiptDateTime

plannedReceiptDateTime: Moment

Date and Time of Planned Receipt.

nullable

Optional plant

plant: undefined | string

Plant. Maximum length: 4.

nullable

Optional previousKanbanContainerStatus

previousKanbanContainerStatus: undefined | string

Previous Kanban Container Status. Maximum length: 1.

nullable

Optional previousLastChangeDate

previousLastChangeDate: Moment

Date of Last Status Change to Full or Emtpy.

nullable

Optional previousLastChangeTime

previousLastChangeTime: Time

Time of Last Status Change to Full or Emtpy.

nullable

Optional productionSupplyArea

productionSupplyArea: undefined | string

Production Supply Area. Maximum length: 10.

nullable

Optional purchasingDocument

purchasingDocument: undefined | string

Purchasing Document. Maximum length: 10.

nullable

Optional purchasingDocumentCategory

purchasingDocumentCategory: undefined | string

Purchasing Document Category. Maximum length: 1.

nullable

Optional purchasingDocumentItem

purchasingDocumentItem: undefined | string

Purchasing Document Item. Maximum length: 5.

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 repetitiveMfgConfirmation

repetitiveMfgConfirmation: undefined | string

Repetitive Manufacturing Confirmation ID. Maximum length: 10.

nullable

Optional requestedQuantityInBaseUnit

requestedQuantityInBaseUnit: BigNumber

Requested Quantity in Base Unit.

nullable

Optional reservation

reservation: undefined | string

Reservation. Maximum length: 10.

nullable

Optional reservationItem

reservationItem: undefined | string

Reservation Item. Maximum length: 4.

nullable

Optional salesDocument

salesDocument: undefined | string

Sales Document. Maximum length: 10.

nullable

Optional salesDocumentItem

salesDocumentItem: undefined | string

Sales Document Item. Maximum length: 6.

nullable

Optional sequentialNmbrOfSuplrConf

sequentialNmbrOfSuplrConf: undefined | string

Sequential Number of Supplier Confirmation. Maximum length: 4.

nullable

toKanbanControlCycle

toKanbanControlCycle: KanbanControlCycle

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

toKanbanCtnDetailedQty

toKanbanCtnDetailedQty: KanbanCtnDetailedQty[]

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

toKanbanDelivery

toKanbanDelivery: KanbanDelivery

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

Optional transferRequirementItem

transferRequirementItem: undefined | string

Transfer Requirement Item. Maximum length: 4.

nullable

Optional transferRequirementNumber

transferRequirementNumber: undefined | string

Transfer Requirement. Maximum length: 10.

nullable

Optional warehouse

warehouse: undefined | string

Warehouse. Maximum length: 3.

nullable

Optional warehouseTask

warehouseTask: undefined | string

Warehouse Task. Maximum length: 12.

nullable

Optional whseGoodsMovementDocument

whseGoodsMovementDocument: undefined | string

Warehouse Goods Movement Document. Maximum length: 12.

nullable

Optional whseGoodsMovementDocumentItem

whseGoodsMovementDocumentItem: undefined | string

Warehoue Goods Movement Document Item. Maximum length: 4.

nullable

Static ACTUAL_QUANTITY_IN_BASE_UNIT

ACTUAL_QUANTITY_IN_BASE_UNIT: BigNumberField<KanbanContainer> = new BigNumberField('ActualQuantityInBaseUnit', KanbanContainer, 'Edm.Decimal')

Static representation of the actualQuantityInBaseUnit 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<KanbanContainer> = new AllFields('*', KanbanContainer)

All fields selector.

Static BACKFLUSH_REPORTING_POINT

BACKFLUSH_REPORTING_POINT: StringField<KanbanContainer> = new StringField('BackflushReportingPoint', KanbanContainer, 'Edm.String')

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

Static BASE_UNIT

BASE_UNIT: StringField<KanbanContainer> = new StringField('BaseUnit', KanbanContainer, '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 CHANGED_PACKG_INSTRN_DATA_IS_AVAIL

CHANGED_PACKG_INSTRN_DATA_IS_AVAIL: BooleanField<KanbanContainer> = new BooleanField('ChangedPackgInstrnDataIsAvail', KanbanContainer, 'Edm.Boolean')

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

Static INTERNAL_JIT_CALL_NUMBER

INTERNAL_JIT_CALL_NUMBER: StringField<KanbanContainer> = new StringField('InternalJITCallNumber', KanbanContainer, 'Edm.String')

Static representation of the internalJitCallNumber 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: BooleanField<KanbanContainer> = new BooleanField('IsDeleted', KanbanContainer, 'Edm.Boolean')

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 IS_LOCKED

IS_LOCKED: BooleanField<KanbanContainer> = new BooleanField('IsLocked', KanbanContainer, 'Edm.Boolean')

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

Static JIT_CALL_ITEM_NUMBER

JIT_CALL_ITEM_NUMBER: StringField<KanbanContainer> = new StringField('JITCallItemNumber', KanbanContainer, 'Edm.String')

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

Static KANBAN_CONTAINER

KANBAN_CONTAINER: StringField<KanbanContainer> = new StringField('KanbanContainer', KanbanContainer, 'Edm.String')

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

Static KANBAN_CONTAINER_STATUS

KANBAN_CONTAINER_STATUS: StringField<KanbanContainer> = new StringField('KanbanContainerStatus', KanbanContainer, 'Edm.String')

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

Static KANBAN_CONTROL_CYCLE

KANBAN_CONTROL_CYCLE: StringField<KanbanContainer> = new StringField('KanbanControlCycle', KanbanContainer, 'Edm.String')

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

Static KANBAN_CONTROL_CYCLE_ITEM

KANBAN_CONTROL_CYCLE_ITEM: StringField<KanbanContainer> = new StringField('KanbanControlCycleItem', KanbanContainer, 'Edm.String')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<KanbanContainer> = new DateField('LastChangeDate', KanbanContainer, 'Edm.DateTime')

Static representation of the lastChangeDate 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<KanbanContainer> = new DateField('LastChangeDateTime', KanbanContainer, '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 LAST_CHANGE_TIME

LAST_CHANGE_TIME: TimeField<KanbanContainer> = new TimeField('LastChangeTime', KanbanContainer, 'Edm.Time')

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

Static MATERIAL_DOCUMENT

MATERIAL_DOCUMENT: StringField<KanbanContainer> = new StringField('MaterialDocument', KanbanContainer, 'Edm.String')

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

Static MATERIAL_DOCUMENT_ITEM

MATERIAL_DOCUMENT_ITEM: StringField<KanbanContainer> = new StringField('MaterialDocumentItem', KanbanContainer, 'Edm.String')

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

Static MATERIAL_DOCUMENT_YEAR

MATERIAL_DOCUMENT_YEAR: StringField<KanbanContainer> = new StringField('MaterialDocumentYear', KanbanContainer, 'Edm.String')

Static representation of the materialDocumentYear 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<KanbanContainer> = new StringField('OrderID', KanbanContainer, '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 PLANNED_ORDER

PLANNED_ORDER: StringField<KanbanContainer> = new StringField('PlannedOrder', KanbanContainer, 'Edm.String')

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

Static PLANNED_RECEIPT_DATE_TIME

PLANNED_RECEIPT_DATE_TIME: DateField<KanbanContainer> = new DateField('PlannedReceiptDateTime', KanbanContainer, 'Edm.DateTimeOffset')

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

Static PLANT

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

PREVIOUS_KANBAN_CONTAINER_STATUS: StringField<KanbanContainer> = new StringField('PreviousKanbanContainerStatus', KanbanContainer, 'Edm.String')

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

Static PREVIOUS_LAST_CHANGE_DATE

PREVIOUS_LAST_CHANGE_DATE: DateField<KanbanContainer> = new DateField('PreviousLastChangeDate', KanbanContainer, 'Edm.DateTime')

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

Static PREVIOUS_LAST_CHANGE_TIME

PREVIOUS_LAST_CHANGE_TIME: TimeField<KanbanContainer> = new TimeField('PreviousLastChangeTime', KanbanContainer, 'Edm.Time')

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

Static PRODUCTION_SUPPLY_AREA

PRODUCTION_SUPPLY_AREA: StringField<KanbanContainer> = new StringField('ProductionSupplyArea', KanbanContainer, 'Edm.String')

Static representation of the productionSupplyArea 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<KanbanContainer> = new StringField('PurchasingDocument', KanbanContainer, '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_CATEGORY

PURCHASING_DOCUMENT_CATEGORY: StringField<KanbanContainer> = new StringField('PurchasingDocumentCategory', KanbanContainer, 'Edm.String')

Static representation of the purchasingDocumentCategory 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<KanbanContainer> = new StringField('PurchasingDocumentItem', KanbanContainer, '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 REPETITIVE_MFG_CONFIRMATION

REPETITIVE_MFG_CONFIRMATION: StringField<KanbanContainer> = new StringField('RepetitiveMfgConfirmation', KanbanContainer, 'Edm.String')

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

Static REQUESTED_QUANTITY_IN_BASE_UNIT

REQUESTED_QUANTITY_IN_BASE_UNIT: BigNumberField<KanbanContainer> = new BigNumberField('RequestedQuantityInBaseUnit', KanbanContainer, 'Edm.Decimal')

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

Static RESERVATION

RESERVATION: StringField<KanbanContainer> = new StringField('Reservation', KanbanContainer, '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<KanbanContainer> = new StringField('ReservationItem', KanbanContainer, '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 SALES_DOCUMENT

SALES_DOCUMENT: StringField<KanbanContainer> = new StringField('SalesDocument', KanbanContainer, 'Edm.String')

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

Static SALES_DOCUMENT_ITEM

SALES_DOCUMENT_ITEM: StringField<KanbanContainer> = new StringField('SalesDocumentItem', KanbanContainer, 'Edm.String')

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

Static SEQUENTIAL_NMBR_OF_SUPLR_CONF

SEQUENTIAL_NMBR_OF_SUPLR_CONF: StringField<KanbanContainer> = new StringField('SequentialNmbrOfSuplrConf', KanbanContainer, 'Edm.String')

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

Static TO_KANBAN_CONTROL_CYCLE

TO_KANBAN_CONTROL_CYCLE: OneToOneLink<KanbanContainer, KanbanControlCycle> = new OneToOneLink('to_KanbanControlCycle', KanbanContainer, KanbanControlCycle)

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

Static TO_KANBAN_CTN_DETAILED_QTY

TO_KANBAN_CTN_DETAILED_QTY: Link<KanbanContainer, KanbanCtnDetailedQty> = new Link('to_KanbanCtnDetailedQty', KanbanContainer, KanbanCtnDetailedQty)

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

Static TO_KANBAN_DELIVERY

TO_KANBAN_DELIVERY: OneToOneLink<KanbanContainer, KanbanDelivery> = new OneToOneLink('to_KanbanDelivery', KanbanContainer, KanbanDelivery)

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

Static TRANSFER_REQUIREMENT_ITEM

TRANSFER_REQUIREMENT_ITEM: StringField<KanbanContainer> = new StringField('TransferRequirementItem', KanbanContainer, 'Edm.String')

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

Static TRANSFER_REQUIREMENT_NUMBER

TRANSFER_REQUIREMENT_NUMBER: StringField<KanbanContainer> = new StringField('TransferRequirementNumber', KanbanContainer, 'Edm.String')

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

Static WAREHOUSE

WAREHOUSE: StringField<KanbanContainer> = new StringField('Warehouse', KanbanContainer, 'Edm.String')

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

Static WAREHOUSE_TASK

WAREHOUSE_TASK: StringField<KanbanContainer> = new StringField('WarehouseTask', KanbanContainer, 'Edm.String')

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

Static WHSE_GOODS_MOVEMENT_DOCUMENT

WHSE_GOODS_MOVEMENT_DOCUMENT: StringField<KanbanContainer> = new StringField('WhseGoodsMovementDocument', KanbanContainer, 'Edm.String')

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

Static WHSE_GOODS_MOVEMENT_DOCUMENT_ITEM

WHSE_GOODS_MOVEMENT_DOCUMENT_ITEM: StringField<KanbanContainer> = new StringField('WhseGoodsMovementDocumentItem', KanbanContainer, 'Edm.String')

Static representation of the whseGoodsMovementDocumentItem 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<KanbanContainer> | BooleanField<KanbanContainer> | DateField<KanbanContainer> | TimeField<KanbanContainer> | BigNumberField<KanbanContainer> | Link<KanbanContainer, KanbanCtnDetailedQty> | OneToOneLink<KanbanContainer, KanbanDelivery> | OneToOneLink<KanbanContainer, KanbanControlCycle>> = [KanbanContainer.KANBAN_CONTAINER,KanbanContainer.KANBAN_CONTROL_CYCLE,KanbanContainer.KANBAN_CONTROL_CYCLE_ITEM,KanbanContainer.PLANT,KanbanContainer.PRODUCTION_SUPPLY_AREA,KanbanContainer.KANBAN_CONTAINER_STATUS,KanbanContainer.IS_LOCKED,KanbanContainer.LAST_CHANGE_DATE,KanbanContainer.LAST_CHANGE_TIME,KanbanContainer.PLANNED_ORDER,KanbanContainer.ORDER_ID,KanbanContainer.PURCHASING_DOCUMENT,KanbanContainer.PURCHASING_DOCUMENT_ITEM,KanbanContainer.SALES_DOCUMENT,KanbanContainer.SALES_DOCUMENT_ITEM,KanbanContainer.REPETITIVE_MFG_CONFIRMATION,KanbanContainer.RESERVATION,KanbanContainer.RESERVATION_ITEM,KanbanContainer.MATERIAL_DOCUMENT,KanbanContainer.MATERIAL_DOCUMENT_YEAR,KanbanContainer.MATERIAL_DOCUMENT_ITEM,KanbanContainer.BASE_UNIT,KanbanContainer.ACTUAL_QUANTITY_IN_BASE_UNIT,KanbanContainer.REQUESTED_QUANTITY_IN_BASE_UNIT,KanbanContainer.PREVIOUS_LAST_CHANGE_DATE,KanbanContainer.PREVIOUS_LAST_CHANGE_TIME,KanbanContainer.TRANSFER_REQUIREMENT_NUMBER,KanbanContainer.TRANSFER_REQUIREMENT_ITEM,KanbanContainer.IS_DELETED,KanbanContainer.PREVIOUS_KANBAN_CONTAINER_STATUS,KanbanContainer.INTERNAL_JIT_CALL_NUMBER,KanbanContainer.JIT_CALL_ITEM_NUMBER,KanbanContainer.PLANNED_RECEIPT_DATE_TIME,KanbanContainer.CHANGED_PACKG_INSTRN_DATA_IS_AVAIL,KanbanContainer.SEQUENTIAL_NMBR_OF_SUPLR_CONF,KanbanContainer.BACKFLUSH_REPORTING_POINT,KanbanContainer.PURCHASING_DOCUMENT_CATEGORY,KanbanContainer.WAREHOUSE,KanbanContainer.WAREHOUSE_TASK,KanbanContainer.WHSE_GOODS_MOVEMENT_DOCUMENT,KanbanContainer.WHSE_GOODS_MOVEMENT_DOCUMENT_ITEM,KanbanContainer.LAST_CHANGE_DATE_TIME,KanbanContainer.TO_KANBAN_CTN_DETAILED_QTY,KanbanContainer.TO_KANBAN_DELIVERY,KanbanContainer.TO_KANBAN_CONTROL_CYCLE]

All fields of the KanbanContainer entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_KANBAN_CONTROL_CYCLE_SRV;v=0002"

Default url path for the according service.

Static _entityName

_entityName: string = "A_KanbanContainer"

Technical entity name for KanbanContainer.

Static _keyFields

_keyFields: Array<Selectable<KanbanContainer>> = [KanbanContainer.KANBAN_CONTAINER]

All key fields of the KanbanContainer entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_KANBAN_CONTROL_CYCLE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<KanbanContainer>

    A builder that constructs instances of entity type KanbanContainer.

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

    Returns KanbanContainerRequestBuilder

    A KanbanContainer request builder.