Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "PlannedIndepRqmt" of service "API_PLND_INDEP_RQMT_SRV". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PLND_INDEP_RQMT_SRV for more information.

Hierarchy

  • Entity
    • PlannedIndepRqmt

Implements

Index

Constructors

constructor

  • Returns PlannedIndepRqmt

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 "*".

mrpArea

mrpArea: string

MRP Area. Number of the MRP area for which material requirements planning should be carried out separately. Maximum length: 10.

plant

plant: string

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

Optional plndIndepRqmtInternalId

plndIndepRqmtInternalId: string

Independent Requirements Pointer. Maximum length: 12.

nullable

Optional plndIndepRqmtIsActive

plndIndepRqmtIsActive: string

Indicator: Version Active. This selection determines whether the version is active, that is, relevant to MRP. Maximum length: 1.

nullable

Optional plndIndepRqmtLastChgdDateTime

plndIndepRqmtLastChgdDateTime: 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

plndIndepRqmtType

plndIndepRqmtType: string

Requirements type. The requirements type determines the planning strategy to be used for a particular requirement. Maximum length: 4.

plndIndepRqmtVersion

plndIndepRqmtVersion: string

Version Number for Independent Requirements. Alphanumeric description of a demand program, also known as the (demand) version number. The version number is used for organizational purposes for the creation and further use of the demand program.Versions can be set to active and inactive. Only active versions are included in the planning run.Using the version compare function, you can compare various versions of a demand program with each other.With the version number various planned independent requirements can be indicated according to their origin. For example, whether the demand program results from SOP or from the material forecast.You can also create versions for long-term planning. Maximum length: 2.

product

product: string

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

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

requirementPlan

requirementPlan: string

Requirements Plan. Key which can be given to create and to identify one or more planned independent requirements. The requirements plan number is used as a criterion for selection. Maximum length: 10.

Optional requirementPlanIsExternal

requirementPlanIsExternal: boolean

Indicates that the Requirement Plan is external.

nullable

requirementSegment

requirementSegment: string

Requirement Segment. Indicates additional information about the type of requirement. You can freely define which requirement segments are satisfied by which stock segments using segmentation strategies in the transaction Segmentation Strategy Maintenance . Customer 1 accepts quality 1 and 2 while customer 2 accepts only quality 1. This results in 2 different requirement segments which can be assigned to different stock segments. Maximum length: 40.

toPlndIndepRqmtItem

toPlndIndepRqmtItem: PlannedIndepRqmtItem[]

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

All fields selector.

Static MRP_AREA

MRP_AREA: StringField<PlannedIndepRqmt> = new StringField('MRPArea', PlannedIndepRqmt, 'Edm.String')

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

Static PLANT

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

PLND_INDEP_RQMT_INTERNAL_ID: StringField<PlannedIndepRqmt> = new StringField('PlndIndepRqmtInternalID', PlannedIndepRqmt, 'Edm.String')

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

Static PLND_INDEP_RQMT_IS_ACTIVE

PLND_INDEP_RQMT_IS_ACTIVE: StringField<PlannedIndepRqmt> = new StringField('PlndIndepRqmtIsActive', PlannedIndepRqmt, 'Edm.String')

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

Static PLND_INDEP_RQMT_LAST_CHGD_DATE_TIME

PLND_INDEP_RQMT_LAST_CHGD_DATE_TIME: DateField<PlannedIndepRqmt> = new DateField('PlndIndepRqmtLastChgdDateTime', PlannedIndepRqmt, 'Edm.DateTimeOffset')

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

Static PLND_INDEP_RQMT_TYPE

PLND_INDEP_RQMT_TYPE: StringField<PlannedIndepRqmt> = new StringField('PlndIndepRqmtType', PlannedIndepRqmt, 'Edm.String')

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

Static PLND_INDEP_RQMT_VERSION

PLND_INDEP_RQMT_VERSION: StringField<PlannedIndepRqmt> = new StringField('PlndIndepRqmtVersion', PlannedIndepRqmt, 'Edm.String')

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

Static PRODUCT

PRODUCT: StringField<PlannedIndepRqmt> = new StringField('Product', PlannedIndepRqmt, 'Edm.String')

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

Static REQUIREMENT_PLAN

REQUIREMENT_PLAN: StringField<PlannedIndepRqmt> = new StringField('RequirementPlan', PlannedIndepRqmt, 'Edm.String')

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

Static REQUIREMENT_PLAN_IS_EXTERNAL

REQUIREMENT_PLAN_IS_EXTERNAL: BooleanField<PlannedIndepRqmt> = new BooleanField('RequirementPlanIsExternal', PlannedIndepRqmt, 'Edm.Boolean')

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

Static REQUIREMENT_SEGMENT

REQUIREMENT_SEGMENT: StringField<PlannedIndepRqmt> = new StringField('RequirementSegment', PlannedIndepRqmt, 'Edm.String')

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

Static TO_PLND_INDEP_RQMT_ITEM

TO_PLND_INDEP_RQMT_ITEM: Link<PlannedIndepRqmt, PlannedIndepRqmtItem> = new Link('to_PlndIndepRqmtItem', PlannedIndepRqmt, PlannedIndepRqmtItem)

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

Static _allFields

_allFields: Array<StringField<PlannedIndepRqmt> | BooleanField<PlannedIndepRqmt> | DateField<PlannedIndepRqmt> | Link<PlannedIndepRqmt, PlannedIndepRqmtItem>> = [PlannedIndepRqmt.PRODUCT,PlannedIndepRqmt.PLANT,PlannedIndepRqmt.MRP_AREA,PlannedIndepRqmt.PLND_INDEP_RQMT_TYPE,PlannedIndepRqmt.PLND_INDEP_RQMT_VERSION,PlannedIndepRqmt.REQUIREMENT_PLAN,PlannedIndepRqmt.REQUIREMENT_SEGMENT,PlannedIndepRqmt.REQUIREMENT_PLAN_IS_EXTERNAL,PlannedIndepRqmt.PLND_INDEP_RQMT_INTERNAL_ID,PlannedIndepRqmt.PLND_INDEP_RQMT_IS_ACTIVE,PlannedIndepRqmt.PLND_INDEP_RQMT_LAST_CHGD_DATE_TIME,PlannedIndepRqmt.TO_PLND_INDEP_RQMT_ITEM]

All fields of the PlannedIndepRqmt entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "PlannedIndepRqmt"

Technical entity name for PlannedIndepRqmt.

Static _keyFields

_keyFields: Array<Selectable<PlannedIndepRqmt>> = [PlannedIndepRqmt.PRODUCT, PlannedIndepRqmt.PLANT, PlannedIndepRqmt.MRP_AREA, PlannedIndepRqmt.PLND_INDEP_RQMT_TYPE, PlannedIndepRqmt.PLND_INDEP_RQMT_VERSION, PlannedIndepRqmt.REQUIREMENT_PLAN, PlannedIndepRqmt.REQUIREMENT_SEGMENT]

All key fields of the PlannedIndepRqmt entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PLND_INDEP_RQMT_SRV"
deprecated

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

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

  • Returns an entity builder to construct instances PlannedIndepRqmt.

    Returns EntityBuilderType<PlannedIndepRqmt, PlannedIndepRqmtType>

    A builder that constructs instances of entity type PlannedIndepRqmt.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity PlannedIndepRqmt.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PlannedIndepRqmt>

    A builder that constructs instances of entity type PlannedIndepRqmt.

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

    Returns PlannedIndepRqmtRequestBuilder

    A PlannedIndepRqmt request builder.