Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "SegmentHier" of service "API_GRMASTERDATA_SRV". This service is part of the following communication scenarios: Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241), Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336). See https://api.sap.com/api/API_GRMASTERDATA_SRV for more information.

Hierarchy

  • Entity
    • SegmentHier

Implements

Index

Constructors

constructor

  • Returns SegmentHier

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

consolidationSegmentHierarchy

consolidationSegmentHierarchy: string

Segment Hierarchy. Maximum length: 40.

hierarchyNode

hierarchyNode: string

Hierarchy node. Maximum length: 40.

Optional hierarchyNodeLevel

hierarchyNodeLevel: string

Hierarchy Level. Maximum length: 6.

nullable

Optional hierarchyNodeText

hierarchyNodeText: string

Hierarchy node description. Maximum length: 50.

nullable

Optional nodeType

nodeType: string

Hierarchy node type. Maximum length: 1.

nullable

Optional parentNode

parentNode: string

Hierarchy parent node. Maximum length: 40.

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 segment

segment: string

Segment for Segmental Reporting. Maximum length: 10.

nullable

Optional segmentText

segmentText: string

Segment Name. Maximum length: 50.

nullable

Optional sequenceNumber

sequenceNumber: string

Sequence Number. Maximum length: 46.

nullable

toCnsldtnSegment

toCnsldtnSegment: Segment

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

toCnsldtnSegmentHierT

toCnsldtnSegmentHierT: SegmentHierText[]

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

validityEndDate

validityEndDate: Moment

Validity End Date.

Optional validityStartDate

validityStartDate: Moment

Validity Start Date.

nullable

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<SegmentHier> = new AllFields('*', SegmentHier)

All fields selector.

Static CONSOLIDATION_SEGMENT_HIERARCHY

CONSOLIDATION_SEGMENT_HIERARCHY: StringField<SegmentHier> = new StringField('ConsolidationSegmentHierarchy', SegmentHier, 'Edm.String')

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

Static HIERARCHY_NODE

HIERARCHY_NODE: StringField<SegmentHier> = new StringField('HierarchyNode', SegmentHier, 'Edm.String')

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

Static HIERARCHY_NODE_LEVEL

HIERARCHY_NODE_LEVEL: StringField<SegmentHier> = new StringField('HierarchyNodeLevel', SegmentHier, 'Edm.String')

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

Static HIERARCHY_NODE_TEXT

HIERARCHY_NODE_TEXT: StringField<SegmentHier> = new StringField('HierarchyNode_Text', SegmentHier, 'Edm.String')

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

Static NODE_TYPE

NODE_TYPE: StringField<SegmentHier> = new StringField('NodeType', SegmentHier, 'Edm.String')

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

Static PARENT_NODE

PARENT_NODE: StringField<SegmentHier> = new StringField('ParentNode', SegmentHier, 'Edm.String')

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

Static SEGMENT

SEGMENT: StringField<SegmentHier> = new StringField('Segment', SegmentHier, 'Edm.String')

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

Static SEGMENT_TEXT

SEGMENT_TEXT: StringField<SegmentHier> = new StringField('Segment_Text', SegmentHier, 'Edm.String')

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

Static SEQUENCE_NUMBER

SEQUENCE_NUMBER: StringField<SegmentHier> = new StringField('SequenceNumber', SegmentHier, 'Edm.String')

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

Static TO_CNSLDTN_SEGMENT

TO_CNSLDTN_SEGMENT: OneToOneLink<SegmentHier, Segment> = new OneToOneLink('to_CnsldtnSegment', SegmentHier, Segment)

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

Static TO_CNSLDTN_SEGMENT_HIER_T

TO_CNSLDTN_SEGMENT_HIER_T: Link<SegmentHier, SegmentHierText> = new Link('to_CnsldtnSegmentHierT', SegmentHier, SegmentHierText)

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<SegmentHier> = new DateField('ValidityEndDate', SegmentHier, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<SegmentHier> = new DateField('ValidityStartDate', SegmentHier, 'Edm.DateTime')

Static representation of the validityStartDate 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<SegmentHier> | DateField<SegmentHier> | OneToOneLink<SegmentHier, Segment> | Link<SegmentHier, SegmentHierText>> = [SegmentHier.CONSOLIDATION_SEGMENT_HIERARCHY,SegmentHier.HIERARCHY_NODE,SegmentHier.HIERARCHY_NODE_TEXT,SegmentHier.VALIDITY_END_DATE,SegmentHier.PARENT_NODE,SegmentHier.VALIDITY_START_DATE,SegmentHier.SEGMENT,SegmentHier.SEGMENT_TEXT,SegmentHier.SEQUENCE_NUMBER,SegmentHier.HIERARCHY_NODE_LEVEL,SegmentHier.NODE_TYPE,SegmentHier.TO_CNSLDTN_SEGMENT,SegmentHier.TO_CNSLDTN_SEGMENT_HIER_T]

All fields of the SegmentHier entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "SegmentHier"

Technical entity name for SegmentHier.

Static _keyFields

_keyFields: Array<Selectable<SegmentHier>> = [SegmentHier.CONSOLIDATION_SEGMENT_HIERARCHY, SegmentHier.HIERARCHY_NODE, SegmentHier.VALIDITY_END_DATE]

All key fields of the SegmentHier entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_GRMASTERDATA_SRV"
deprecated

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

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

    Returns EntityBuilderType<SegmentHier, SegmentHierType>

    A builder that constructs instances of entity type SegmentHier.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SegmentHier>

    A builder that constructs instances of entity type SegmentHier.

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

    Returns SegmentHierRequestBuilder

    A SegmentHier request builder.