Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_KanbanCtnDetailedQty" 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
    • KanbanCtnDetailedQty

Implements

Index

Constructors

constructor

  • Returns KanbanCtnDetailedQty

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. The actual quantity is the quantity that is in the container when the status is set to "full". The target quantity is the quantity that is defined for the container in the control cycle. Variances between the actual and target quantities may occur if a planned order quantity is manually changed or if a different quantity from the target quantity is posted in a separate goods receipt.

nullable

Optional baseUnit

baseUnit: string

Base Unit of Measure. Maximum length: 3.

nullable

batch

batch: string

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

kanbanContainer

kanbanContainer: string

Kanban Identification Number. Determines the Kanban number. Additional information for Kanban ID numbersEvery kanban is given a number, which is valid across the control cycle from a number range for kanban ID numbers.If you work with barcodes, the first ten figures of the barcode consist of the Kanban number. Maximum length: 10.

Optional kanbanControlCycle

kanbanControlCycle: string

Kanban Control Cycle. Maximum length: 7.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Last Change Timestamp.

nullable

Optional plant

plant: string

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

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACTUAL_QUANTITY_IN_BASE_UNIT

ACTUAL_QUANTITY_IN_BASE_UNIT: BigNumberField<KanbanCtnDetailedQty> = new BigNumberField('ActualQuantityInBaseUnit', KanbanCtnDetailedQty, '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<KanbanCtnDetailedQty> = new AllFields('*', KanbanCtnDetailedQty)

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<KanbanCtnDetailedQty> = new StringField('BaseUnit', KanbanCtnDetailedQty, '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<KanbanCtnDetailedQty> = new StringField('Batch', KanbanCtnDetailedQty, '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 KANBAN_CONTAINER

KANBAN_CONTAINER: StringField<KanbanCtnDetailedQty> = new StringField('KanbanContainer', KanbanCtnDetailedQty, '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_CONTROL_CYCLE

KANBAN_CONTROL_CYCLE: StringField<KanbanCtnDetailedQty> = new StringField('KanbanControlCycle', KanbanCtnDetailedQty, '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 LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<KanbanCtnDetailedQty> = new DateField('LastChangeDateTime', KanbanCtnDetailedQty, '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 PLANT

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

_allFields: Array<StringField<KanbanCtnDetailedQty> | BigNumberField<KanbanCtnDetailedQty> | DateField<KanbanCtnDetailedQty>> = [KanbanCtnDetailedQty.KANBAN_CONTAINER,KanbanCtnDetailedQty.BATCH,KanbanCtnDetailedQty.BASE_UNIT,KanbanCtnDetailedQty.ACTUAL_QUANTITY_IN_BASE_UNIT,KanbanCtnDetailedQty.PLANT,KanbanCtnDetailedQty.LAST_CHANGE_DATE_TIME,KanbanCtnDetailedQty.KANBAN_CONTROL_CYCLE]

All fields of the KanbanCtnDetailedQty 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_KanbanCtnDetailedQty"

Technical entity name for KanbanCtnDetailedQty.

Static _keyFields

_keyFields: Array<Selectable<KanbanCtnDetailedQty>> = [KanbanCtnDetailedQty.KANBAN_CONTAINER, KanbanCtnDetailedQty.BATCH]

All key fields of the KanbanCtnDetailedQty entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_KANBAN_CONTROL_CYCLE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<KanbanCtnDetailedQty>

    A builder that constructs instances of entity type KanbanCtnDetailedQty.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns KanbanCtnDetailedQtyRequestBuilder

    A KanbanCtnDetailedQty request builder.