Class SegmentHierRequestBuilder

Request builder class for operations supported on the SegmentHier entity.

Hierarchy

RequestBuilder<SegmentHier>
- SegmentHierRequestBuilder

Implements

EntityIdentifiable<SegmentHier>

Index

Properties

entityConstructor

Methods

Properties

entityConstructor

entityConstructor: Constructable<SegmentHier>

Methods

getAll

getAll(): GetAllRequestBuilder<SegmentHier>

- Defined in vdm/group-reporting-master-data-service/SegmentHierRequestBuilder.ts:32
Returns a request builder for querying all SegmentHier entities.

Returns GetAllRequestBuilder<SegmentHier>

A request builder for creating requests to retrieve all SegmentHier entities.

getByKey

getByKey(consolidationSegmentHierarchy: string, hierarchyNode: string, validityEndDate: Moment): GetByKeyRequestBuilder<SegmentHier>

- Defined in vdm/group-reporting-master-data-service/SegmentHierRequestBuilder.ts:20
Returns a request builder for retrieving one SegmentHier entity based on its keys.

Parameters
- consolidationSegmentHierarchy: string
  
  Key property. See SegmentHier.consolidationSegmentHierarchy.
- hierarchyNode: string
  
  Key property. See SegmentHier.hierarchyNode.
- validityEndDate: Moment
  
  Key property. See SegmentHier.validityEndDate.
Returns GetByKeyRequestBuilder<SegmentHier>

A request builder for creating requests to retrieve one SegmentHier entity based on its keys.

Static forEntity

forEntity<EntityCT>(entity: EntityCT): EntityBasedRequestBuilder<EntityCT>

Inherited from RequestBuilder.forEntity
- Defined in core/dist/request-builder/request-builder.d.ts:13
Type parameters
- EntityCT: Constructable<Entity>
Parameters
- entity: EntityCT
Returns EntityBasedRequestBuilder<EntityCT>