Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurgQuotaArrangementItem" of service "API_PUR_QUOTA_ARRANGEMENT_SRV". This service is part of the following communication scenarios: Purchasing Quota Arrangement Integration (SAP_COM_0166). See https://api.sap.com/api/API_PUR_QUOTA_ARRANGEMENT_SRV for more information.

Hierarchy

  • Entity
    • PurgQuotaArrangementItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns PurgQuotaArrangementItem

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 manufacturerMaterial

manufacturerMaterial: string

Material number corresponding to manufacturer part number. Uniquely identifies an MPN material. Maximum length: 40.

nullable

Optional materialMaxLotSizeQuantity

materialMaxLotSizeQuantity: BigNumber

Maximum Lot Size per Quota Item. Maximum PO quantity that may be allocated to a source of supply per order proposal in the planning run. If the shortage (undercoverage) quantity exceeds the maximum lot size, the quota system is re-applied to the remaining quantity.

nullable

Optional materialMinLotSizeQuantity

materialMinLotSizeQuantity: BigNumber

Minimum Lot Size per Quota Item. Minimum order quantity that may be allocated to a source of supply per order proposal in the planning run. If the shortage (undercoverage) quantity is less than the minimum lot size, the latter quantity will be allocated to the source instead of the former.

nullable

Optional materialProcurementCategory

materialProcurementCategory: string

Procurement Type. Indicates the type of procurement (that is, in-house manufacture, i.e. "making in", or external procurement, i.e. "buying out") for the quota arrangement item. Maximum length: 1.

nullable

Optional materialProcurementType

materialProcurementType: string

Special procurement type. Indicator that determines the procurement type of the material and, consequently, how the material is procured. A material which is procured externally can be acquired viaa delivery schedule ora consignment order. Maximum length: 1.

nullable

Optional materialRoundingProfile

materialRoundingProfile: string

Rounding Profile. Key that the system uses to adjust the order proposal quantity to deliverable units. In Customizing, enter a threshold value from which the system should round up to the next value per deliverable unit:If the requirements value exceeds the first threshold value, the system always rounds up to the next multiple of the level foundIf the requirements value falls below the first threshold value, the system copies the original requirements value.Two other types of rounding exist:Dynamic rounding profile:These profiles are used to round up quantities to logistical units of measure (for example, layers). The contents of a logistical unit of measure does not have to be know when creating the rounding profile. It is determined by the master data from the material master.Rounding profile with quantity to be added/subtractedWith these profiles, the given quantity is changed either by adding a percentage or subtracting a percentage.Only static rounding profiles are taken into account in requirements planning. Neither dynamic rounding profiles not quantity addition/ subtraction are taken into account.A material's base unit of measure is 1 unit; the purchase order is to be delivered in layers (1 layer corresponds to 5 units) or in pallets (1 pallet corresponds to 8 layers which contains 40 units).You maintain the profile as follows:From a requirements of 2 units, the system is to round up to 5; from a requirement of 32 units, the system is to round up to 40.This results in the following order proposal quantities:Requirement from 1 -> 1 requirement from 31 -> 30Requirement from 2 -> 5 requirement from 32 -> 40Requirement from 6 -> 10 requirement from 74 -> 80Requirement from 7 -> 10If no rounding profile has been entered, the system uses the rounding value entered in the material master record for the planning run. Maximum length: 4.

nullable

Optional maximumReleaseQuantity

maximumReleaseQuantity: BigNumber

Maximum Release Quantity per Period. The "maximum release quantity" defines the maximum quantity that a source of supply can make available/supply within a specified timeframe. If a source with a maximum release quantity is next in line in a quota arrangement, in total no more than this maximum figure can be allocated to it within the specified period. If the lot in question exceeds this maximum, it will be split. The source in question will receive an order covering the difference between the quantity already released and the maximum release quantity. The balance of the lot will be allocated to the next source.The maximum release quantity is only taken into account in the planning run within MRP, not when purchase requisitions or planned orders are created manually.

nullable

Optional numberOfPeriodsPerRelQuantity

numberOfPeriodsPerRelQuantity: string

Number of Periods to Which the Release Quantity Relates. In this field, you determine the number of periods for which the maximum release quantity is valid. Maximum length: 2.

nullable

Optional plannedDeliveryDurationInDays

plannedDeliveryDurationInDays: BigNumber

Planned Delivery Time in Days. Number of calendar days needed to obtain the material or service if it is procured externally. If you have different vendors for a material, you must specify an average value. The same applies if you order the material from a fixed vendor that has varying delivery times.If you use the SAP Retail System, the planned delivery time can be suggested from the vendor sub-range in the vendor master record.

nullable

Optional productionVersion

productionVersion: string

Production Version. Key which determines the various production techniques according to which a material can be manufactured. The production version determines the following:the BOM alternative for a BOM explosionthe task list type, the task list group and the task list group counter for allocation to task listslot-size restrictions for repetitive manufacturing. Maximum length: 4.

nullable

Optional purchasingSourceQuota

purchasingSourceQuota: BigNumber

Quota. Number specifying which portion of a requirement is to be procured from a given source of supply. If a certain material is to be procured alternately from different suppliers, you can create aquota arrangement item for each supplier and assign a quota to each such item. The system then selects the effective source of supply at any given time by means of the following formula:quota rating = quota base quantity + quota-allocated quantity----------------------------------------------quotaThis quota rating is calculated for all sources of supply included in the quota arrangement. The source then selected is the one with the lowest rating.Which supplier or item of an outline purchase agreement is valid at a certain point in time is determined via the source list.Enter the portion of the material requirement that is to be procured from the source. The value is automatically converted into a percentage.If the quota is to be temporarily excluded from the quota arrangement, you can set the quota to '_'.The requirement of a material is to be evenly distributed among three suppliers. That is, the system is to allocate a third of the total requirement to each supplier.Enter 1 as quota for each supplier; the quota per supplier will then automatically be converted to 33%.

nullable

Optional quotaAllocatedQuantity

quotaAllocatedQuantity: BigNumber

Allocated Quantity of Quota Arrangement Item. Total quantity procured to date from the quota arrangement item source. This value is updated in planned orders, purchase requisitions, purchase orders, and scheduling agreement delivery schedule lines.

nullable

quotaArrangement

quotaArrangement: string

Number of quota arrangement. Uniquely identifies the quota arrangement. Maximum length: 10.

quotaArrangementItem

quotaArrangementItem: string

Quota arrangement item. Uniquely identifies the quota arrangement item within a quota arrangement period. Maximum length: 3.

Optional quotaBaseQuantity

quotaBaseQuantity: BigNumber

Quota Base Quantity of Quota Arrangement Item. Control quantity for a quota arrangement. Using the quota base quantity, you can regulate the quota arrangement without having to change the quota if, for example, a new source is to be included in the arrangement.You can set the quota base quantity manually or have it determined by the system.

nullable

Optional quotaDeterminationPriority

quotaDeterminationPriority: string

Priority for Determination of Sequence. The priority determines the sequence in which the individual sources of supply are used. Items with priority are always taken into consideration first, before the items for which no priority has been entered. Example without splitting quota:If, for example, you enter priority one along with a maximum release quantity, then this source of supply is always selected until its maximum release quantity has been exhausted. Only then is the next source of supply selected.If no maximum release quantity was entered for the item with priority one, this item would always receive the complete requirement quantity.Example with splitting quota:In this procedure, the items are selected in the order of the quota. This sequence can be overridden using priorities.Please note that the splitting quantity is always based on the quota. Maximum length: 2.

nullable

Optional quotaMaximumQuantity

quotaMaximumQuantity: BigNumber

Maximum Quantity of Quota Arrangement Item. A quota arrangement item is no longer suggested as the source if the quota-allocated quantity is equal to or exceeds the maximum quantity.

nullable

Optional quotaReleasePeriodType

quotaReleasePeriodType: string

Period to Which the Release Quantity Relates. Maximum length: 1.

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 sourceOfSupplyIsAssignedOnce

sourceOfSupplyIsAssignedOnce: boolean

Indicator: "Once-Only". Specifies that a source may only be taken into account once in the apportionment of a lot. If a maximum lot size is specified for a source of supply, and if this source has a much lower quota rating than other sources, the following happens: the lot is split up into several order proposals (each of which amounts to the maximum lot size) which are all assigned to the the source in question.To avoid this, you can set the "once-only" indicator. This will cause the source to be taken into account once only for an amount equal to the maximum lot size. The remaining quantity will be assigned to the next source.

nullable

Optional supplier

supplier: string

Vendor Account Number. Alphanumeric key uniquely identifying the document. With the supplier number, information from the supplier master record (such as the supplier's address and bank details) is copied into a purchasing document (such as a request for quotation or a purchase order).You can use the supplier number to keep track of requests for quotation, purchase orders and outline agreements. Maximum length: 10.

nullable

Optional supplyingPlant

supplyingPlant: string

Plant from Which Material is Procured. Key for the factory or branch of a company (that is, a company code), from which the material is to be procured. You can only enter one supplier number or one plant per quota arrangement item.In the case of process orders, this field should remain empty if the quota arrangement is being used to select a production version. Maximum length: 4.

nullable

toPurchasingQuotaArrangement

toPurchasingQuotaArrangement: PurchasingQuotaArrangement

One-to-one navigation property to the PurchasingQuotaArrangement 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<PurgQuotaArrangementItem> = new AllFields('*', PurgQuotaArrangementItem)

All fields selector.

Static MANUFACTURER_MATERIAL

MANUFACTURER_MATERIAL: StringField<PurgQuotaArrangementItem> = new StringField('ManufacturerMaterial', PurgQuotaArrangementItem, 'Edm.String')

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

Static MATERIAL_MAX_LOT_SIZE_QUANTITY

MATERIAL_MAX_LOT_SIZE_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('MaterialMaxLotSizeQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static MATERIAL_MIN_LOT_SIZE_QUANTITY

MATERIAL_MIN_LOT_SIZE_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('MaterialMinLotSizeQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static MATERIAL_PROCUREMENT_CATEGORY

MATERIAL_PROCUREMENT_CATEGORY: StringField<PurgQuotaArrangementItem> = new StringField('MaterialProcurementCategory', PurgQuotaArrangementItem, 'Edm.String')

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

Static MATERIAL_PROCUREMENT_TYPE

MATERIAL_PROCUREMENT_TYPE: StringField<PurgQuotaArrangementItem> = new StringField('MaterialProcurementType', PurgQuotaArrangementItem, 'Edm.String')

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

Static MATERIAL_ROUNDING_PROFILE

MATERIAL_ROUNDING_PROFILE: StringField<PurgQuotaArrangementItem> = new StringField('MaterialRoundingProfile', PurgQuotaArrangementItem, 'Edm.String')

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

Static MAXIMUM_RELEASE_QUANTITY

MAXIMUM_RELEASE_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('MaximumReleaseQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static NUMBER_OF_PERIODS_PER_REL_QUANTITY

NUMBER_OF_PERIODS_PER_REL_QUANTITY: StringField<PurgQuotaArrangementItem> = new StringField('NumberOfPeriodsPerRelQuantity', PurgQuotaArrangementItem, 'Edm.String')

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

Static PLANNED_DELIVERY_DURATION_IN_DAYS

PLANNED_DELIVERY_DURATION_IN_DAYS: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('PlannedDeliveryDurationInDays', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static PRODUCTION_VERSION

PRODUCTION_VERSION: StringField<PurgQuotaArrangementItem> = new StringField('ProductionVersion', PurgQuotaArrangementItem, 'Edm.String')

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

Static PURCHASING_SOURCE_QUOTA

PURCHASING_SOURCE_QUOTA: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('PurchasingSourceQuota', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static QUOTA_ALLOCATED_QUANTITY

QUOTA_ALLOCATED_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('QuotaAllocatedQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static QUOTA_ARRANGEMENT

QUOTA_ARRANGEMENT: StringField<PurgQuotaArrangementItem> = new StringField('QuotaArrangement', PurgQuotaArrangementItem, 'Edm.String')

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

Static QUOTA_ARRANGEMENT_ITEM

QUOTA_ARRANGEMENT_ITEM: StringField<PurgQuotaArrangementItem> = new StringField('QuotaArrangementItem', PurgQuotaArrangementItem, 'Edm.String')

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

Static QUOTA_BASE_QUANTITY

QUOTA_BASE_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('QuotaBaseQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static QUOTA_DETERMINATION_PRIORITY

QUOTA_DETERMINATION_PRIORITY: StringField<PurgQuotaArrangementItem> = new StringField('QuotaDeterminationPriority', PurgQuotaArrangementItem, 'Edm.String')

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

Static QUOTA_MAXIMUM_QUANTITY

QUOTA_MAXIMUM_QUANTITY: BigNumberField<PurgQuotaArrangementItem> = new BigNumberField('QuotaMaximumQuantity', PurgQuotaArrangementItem, 'Edm.Decimal')

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

Static QUOTA_RELEASE_PERIOD_TYPE

QUOTA_RELEASE_PERIOD_TYPE: StringField<PurgQuotaArrangementItem> = new StringField('QuotaReleasePeriodType', PurgQuotaArrangementItem, 'Edm.String')

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

Static SOURCE_OF_SUPPLY_IS_ASSIGNED_ONCE

SOURCE_OF_SUPPLY_IS_ASSIGNED_ONCE: BooleanField<PurgQuotaArrangementItem> = new BooleanField('SourceOfSupplyIsAssignedOnce', PurgQuotaArrangementItem, 'Edm.Boolean')

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

Static SUPPLIER

SUPPLIER: StringField<PurgQuotaArrangementItem> = new StringField('Supplier', PurgQuotaArrangementItem, 'Edm.String')

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

Static SUPPLYING_PLANT

SUPPLYING_PLANT: StringField<PurgQuotaArrangementItem> = new StringField('SupplyingPlant', PurgQuotaArrangementItem, 'Edm.String')

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

Static TO_PURCHASING_QUOTA_ARRANGEMENT

TO_PURCHASING_QUOTA_ARRANGEMENT: OneToOneLink<PurgQuotaArrangementItem, PurchasingQuotaArrangement> = new OneToOneLink('to_PurchasingQuotaArrangement', PurgQuotaArrangementItem, PurchasingQuotaArrangement)

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

Static _allFields

_allFields: Array<StringField<PurgQuotaArrangementItem> | BigNumberField<PurgQuotaArrangementItem> | BooleanField<PurgQuotaArrangementItem> | OneToOneLink<PurgQuotaArrangementItem, PurchasingQuotaArrangement>> = [PurgQuotaArrangementItem.QUOTA_ARRANGEMENT,PurgQuotaArrangementItem.QUOTA_ARRANGEMENT_ITEM,PurgQuotaArrangementItem.MATERIAL_PROCUREMENT_CATEGORY,PurgQuotaArrangementItem.MATERIAL_PROCUREMENT_TYPE,PurgQuotaArrangementItem.SUPPLIER,PurgQuotaArrangementItem.SUPPLYING_PLANT,PurgQuotaArrangementItem.PURCHASING_SOURCE_QUOTA,PurgQuotaArrangementItem.QUOTA_BASE_QUANTITY,PurgQuotaArrangementItem.QUOTA_ALLOCATED_QUANTITY,PurgQuotaArrangementItem.QUOTA_MAXIMUM_QUANTITY,PurgQuotaArrangementItem.PRODUCTION_VERSION,PurgQuotaArrangementItem.MATERIAL_MAX_LOT_SIZE_QUANTITY,PurgQuotaArrangementItem.MATERIAL_MIN_LOT_SIZE_QUANTITY,PurgQuotaArrangementItem.MATERIAL_ROUNDING_PROFILE,PurgQuotaArrangementItem.SOURCE_OF_SUPPLY_IS_ASSIGNED_ONCE,PurgQuotaArrangementItem.MAXIMUM_RELEASE_QUANTITY,PurgQuotaArrangementItem.QUOTA_RELEASE_PERIOD_TYPE,PurgQuotaArrangementItem.NUMBER_OF_PERIODS_PER_REL_QUANTITY,PurgQuotaArrangementItem.QUOTA_DETERMINATION_PRIORITY,PurgQuotaArrangementItem.MANUFACTURER_MATERIAL,PurgQuotaArrangementItem.PLANNED_DELIVERY_DURATION_IN_DAYS,PurgQuotaArrangementItem.TO_PURCHASING_QUOTA_ARRANGEMENT]

All fields of the PurgQuotaArrangementItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurgQuotaArrangementItem"

Technical entity name for PurgQuotaArrangementItem.

Static _keyFields

_keyFields: Array<Selectable<PurgQuotaArrangementItem>> = [PurgQuotaArrangementItem.QUOTA_ARRANGEMENT, PurgQuotaArrangementItem.QUOTA_ARRANGEMENT_ITEM]

All key fields of the PurgQuotaArrangementItem entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PUR_QUOTA_ARRANGEMENT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurgQuotaArrangementItem>

    A builder that constructs instances of entity type PurgQuotaArrangementItem.

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

    Returns PurgQuotaArrangementItemRequestBuilder

    A PurgQuotaArrangementItem request builder.