/AWS1/CL_PTBGETBENEFALLOCOUT¶
GetBenefitAllocationOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/PTBBENEFITALLOCATIONID /AWS1/PTBBENEFITALLOCATIONID¶
The unique identifier of the benefit allocation.
iv_catalog TYPE /AWS1/PTBCATALOGNAME /AWS1/PTBCATALOGNAME¶
The catalog identifier that the benefit allocation belongs to.
iv_arn TYPE /AWS1/PTBBENEFITALLOCATIONARN /AWS1/PTBBENEFITALLOCATIONARN¶
The Amazon Resource Name (ARN) of the benefit allocation.
iv_name TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING¶
The human-readable name of the benefit allocation.
iv_description TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING¶
A detailed description of the benefit allocation.
iv_status TYPE /AWS1/PTBBENEFITALLOCSTATUS /AWS1/PTBBENEFITALLOCSTATUS¶
The current status of the benefit allocation (e.g., active, expired, consumed).
iv_statusreason TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING¶
Additional information explaining the current status of the benefit allocation.
iv_benefitapplicationid TYPE /AWS1/PTBBENEFITAPPLICATIONID /AWS1/PTBBENEFITAPPLICATIONID¶
The identifier of the benefit application that resulted in this allocation.
iv_benefitid TYPE /AWS1/PTBBENEFITID /AWS1/PTBBENEFITID¶
The identifier of the benefit that this allocation is based on.
iv_fulfillmenttype TYPE /AWS1/PTBFULFILLMENTTYPE /AWS1/PTBFULFILLMENTTYPE¶
The fulfillment type used for this benefit allocation.
it_applicablebenefitids TYPE /AWS1/CL_PTBBENEFITIDS_W=>TT_BENEFITIDENTIFIERS TT_BENEFITIDENTIFIERS¶
A list of benefit identifiers that this allocation can be applied to.
io_fulfillmentdetail TYPE REF TO /AWS1/CL_PTBFULFILLMENTDETAILS /AWS1/CL_PTBFULFILLMENTDETAILS¶
Detailed information about how the benefit allocation is fulfilled.
iv_createdat TYPE /AWS1/PTBTIMESTAMP /AWS1/PTBTIMESTAMP¶
The timestamp when the benefit allocation was created.
iv_updatedat TYPE /AWS1/PTBTIMESTAMP /AWS1/PTBTIMESTAMP¶
The timestamp when the benefit allocation was last updated.
iv_startsat TYPE /AWS1/PTBTIMESTAMP /AWS1/PTBTIMESTAMP¶
The timestamp when the benefit allocation becomes active and usable.
iv_expiresat TYPE /AWS1/PTBTIMESTAMP /AWS1/PTBTIMESTAMP¶
The timestamp when the benefit allocation expires and is no longer usable.
Queryable Attributes¶
Id¶
The unique identifier of the benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Catalog¶
The catalog identifier that the benefit allocation belongs to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CATALOG() |
Getter for CATALOG, with configurable default |
ASK_CATALOG() |
Getter for CATALOG w/ exceptions if field has no value |
HAS_CATALOG() |
Determine if CATALOG has a value |
Arn¶
The Amazon Resource Name (ARN) of the benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Name¶
The human-readable name of the benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Description¶
A detailed description of the benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Status¶
The current status of the benefit allocation (e.g., active, expired, consumed).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusReason¶
Additional information explaining the current status of the benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
BenefitApplicationId¶
The identifier of the benefit application that resulted in this allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BENEFITAPPLICATIONID() |
Getter for BENEFITAPPLICATIONID, with configurable default |
ASK_BENEFITAPPLICATIONID() |
Getter for BENEFITAPPLICATIONID w/ exceptions if field has n |
HAS_BENEFITAPPLICATIONID() |
Determine if BENEFITAPPLICATIONID has a value |
BenefitId¶
The identifier of the benefit that this allocation is based on.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BENEFITID() |
Getter for BENEFITID, with configurable default |
ASK_BENEFITID() |
Getter for BENEFITID w/ exceptions if field has no value |
HAS_BENEFITID() |
Determine if BENEFITID has a value |
FulfillmentType¶
The fulfillment type used for this benefit allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FULFILLMENTTYPE() |
Getter for FULFILLMENTTYPE, with configurable default |
ASK_FULFILLMENTTYPE() |
Getter for FULFILLMENTTYPE w/ exceptions if field has no val |
HAS_FULFILLMENTTYPE() |
Determine if FULFILLMENTTYPE has a value |
ApplicableBenefitIds¶
A list of benefit identifiers that this allocation can be applied to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICABLEBENEFITIDS() |
Getter for APPLICABLEBENEFITIDS, with configurable default |
ASK_APPLICABLEBENEFITIDS() |
Getter for APPLICABLEBENEFITIDS w/ exceptions if field has n |
HAS_APPLICABLEBENEFITIDS() |
Determine if APPLICABLEBENEFITIDS has a value |
FulfillmentDetail¶
Detailed information about how the benefit allocation is fulfilled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FULFILLMENTDETAIL() |
Getter for FULFILLMENTDETAIL |
CreatedAt¶
The timestamp when the benefit allocation was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
UpdatedAt¶
The timestamp when the benefit allocation was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
StartsAt¶
The timestamp when the benefit allocation becomes active and usable.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTSAT() |
Getter for STARTSAT, with configurable default |
ASK_STARTSAT() |
Getter for STARTSAT w/ exceptions if field has no value |
HAS_STARTSAT() |
Determine if STARTSAT has a value |
ExpiresAt¶
The timestamp when the benefit allocation expires and is no longer usable.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRESAT() |
Getter for EXPIRESAT, with configurable default |
ASK_EXPIRESAT() |
Getter for EXPIRESAT w/ exceptions if field has no value |
HAS_EXPIRESAT() |
Determine if EXPIRESAT has a value |