Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_Incident" of service "API_EHS_REPORT_INCIDENT_SRV". This service is part of the following communication scenarios: Environment, Health and Safety - Incident Reporting Integration (SAP_COM_0369). See https://api.sap.com/api/API_EHS_REPORT_INCIDENT_SRV for more information.

Hierarchy

  • Entity
    • Incident

Implements

Index

Constructors

constructor

  • Returns Incident

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

ehsLocationUuid

ehsLocationUuid: string

Location. Specifies the location.

incidentCategory

incidentCategory: string

Incident Category. Classifies the incident. The following categories are used for an incident: IncidentNear MissSafety Observation. Maximum length: 3.

incidentLocationDescription

incidentLocationDescription: string

Additional Location Description. Maximum length: 499999.

incidentStatus

incidentStatus: string

Incident Record Status. Indicates the status of the incident record, for example, approved. After you enter or change information and choose the Save pushbutton, the system automatically assigns the appropriate status to the incident record. By choosing the Set Next Status pushbutton, you can choose to assign a status to the record. Maximum length: 40.

incidentTitle

incidentTitle: string

Incident Title. Specifies the descriptive or general heading of an incident, a near miss, a safety observation, or an incident of group deviation. You can use the title much like a label to distinguish quickly between records. When you search the data records in incident management, the title is often displayed together with the incident category, incident ID, and the short info (a composite of the injured person(s) and incident date). Maximum length: 80.

incidentUtcDateTime

incidentUtcDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss). The UTC time stamp is the date and time relative to UTC (Universal Coordinated Time). To standardize local times in a UTC time stamp and thus make them comparable with other times, these local times need to be converted using your time zone and the ABAP command convert.Even if the system is able to determine the time zone from Customizing or master data, you shoul save the time zone redundantly here.The internal structure of the UTC time stamp is subdivided into a date part and a time part in packed number format <YYYYMMDDhhmmss>. You can also use the high resolution UTC time stamp (10^-7 seconds).

incidentUuid

incidentUuid: string

NodeID.

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

toAttachments

toAttachments: Attachment[]

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

toLocation

toLocation: Location

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

toPersons

toPersons: Person[]

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

Static ALL_FIELDS

ALL_FIELDS: AllFields<Incident> = new AllFields('*', Incident)

All fields selector.

Static EHS_LOCATION_UUID

EHS_LOCATION_UUID: StringField<Incident> = new StringField('EHSLocationUUID', Incident, 'Edm.Guid')

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

Static INCIDENT_CATEGORY

INCIDENT_CATEGORY: StringField<Incident> = new StringField('IncidentCategory', Incident, 'Edm.String')

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

Static INCIDENT_LOCATION_DESCRIPTION

INCIDENT_LOCATION_DESCRIPTION: StringField<Incident> = new StringField('IncidentLocationDescription', Incident, 'Edm.String')

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

Static INCIDENT_STATUS

INCIDENT_STATUS: StringField<Incident> = new StringField('IncidentStatus', Incident, 'Edm.String')

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

Static INCIDENT_TITLE

INCIDENT_TITLE: StringField<Incident> = new StringField('IncidentTitle', Incident, 'Edm.String')

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

Static INCIDENT_UTC_DATE_TIME

INCIDENT_UTC_DATE_TIME: DateField<Incident> = new DateField('IncidentUTCDateTime', Incident, 'Edm.DateTimeOffset')

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

Static INCIDENT_UUID

INCIDENT_UUID: StringField<Incident> = new StringField('IncidentUUID', Incident, 'Edm.Guid')

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

Static TO_ATTACHMENTS

TO_ATTACHMENTS: Link<Incident, Attachment> = new Link('to_Attachments', Incident, Attachment)

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

Static TO_LOCATION

TO_LOCATION: OneToOneLink<Incident, Location> = new OneToOneLink('to_Location', Incident, Location)

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

Static TO_PERSONS

TO_PERSONS: Link<Incident, Person> = new Link('to_Persons', Incident, Person)

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

Static _allFields

_allFields: Array<StringField<Incident> | DateField<Incident> | Link<Incident, Attachment> | OneToOneLink<Incident, Location> | Link<Incident, Person>> = [Incident.INCIDENT_UUID,Incident.INCIDENT_CATEGORY,Incident.INCIDENT_STATUS,Incident.INCIDENT_TITLE,Incident.INCIDENT_UTC_DATE_TIME,Incident.INCIDENT_LOCATION_DESCRIPTION,Incident.EHS_LOCATION_UUID,Incident.TO_ATTACHMENTS,Incident.TO_LOCATION,Incident.TO_PERSONS]

All fields of the Incident entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_Incident"

Technical entity name for Incident.

Static _keyFields

_keyFields: Array<Selectable<Incident>> = [Incident.INCIDENT_UUID]

All key fields of the Incident entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_EHS_REPORT_INCIDENT_SRV"
deprecated

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

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

  • customField(fieldName: string): CustomField<Incident>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity Incident.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Incident>

    A builder that constructs instances of entity type Incident.

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

    Returns IncidentRequestBuilder

    A Incident request builder.