Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Class DefaultEquipmentHierarchyService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultEquipmentHierarchyService

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, EquipmentHierarchyService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultEquipmentHierarchyService")
public class DefaultEquipmentHierarchyService
extends Object
implements ServiceWithNavigableEntities, EquipmentHierarchyService

This service allows you to read the hierarchy of an equipment along with a list of subequipment that is installed on the superior equipment. The request contains all the information that is necessary to read an equipment hierarchy. If the input in the request is not as expected, the system displays appropriate error or warning messages in the response. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	EQUIPMENTSTRUCLIST_0001
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Asset Management Master Data Integration(SAP_COM_0395)
Scope Items:	Service Order Management and Monitoring(3D2), Service Contract Management(3MO), In-House Repair(3XK), Reactive Maintenance(4HH), Proactive Maintenance(4HI), Improvement Maintenance(4VT), Operational and Overhead Maintenance(4WM), Corrective Maintenance(BH1), Emergency Maintenance(BH2), Preventive Maintenance(BJ2), Reactive Maintenance(OHH), Proactive Maintenance(OHI), PSM: Preventive Maintenance(OJ2), Improvement Maintenance(OVT), Operational and Overhead Maintenance(OWM), Service Order Processing with SAP Field Service Management(49X), Service Quotation(4GA)
Authentication Methods:	x509
Service Group Name:	API_EQUIPMENT_STRUCLIST
Business Object:	Equipment

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.EquipmentHierarchyService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultEquipmentHierarchyService()	Creates a service using EquipmentHierarchyService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Creates a batch request builder object.
CountRequestBuilder<EquipmentStrucList>	countEquipmentStructureList()	Fetch the number of entries from the EquipmentStrucList entity collection matching the filter and search expressions.
GetAllRequestBuilder<EquipmentStrucList>	getAllEquipmentStructureList()	Fetch multiple EquipmentStrucList entities.
GetByKeyRequestBuilder<EquipmentStrucList>	getEquipmentStructureListByKey(String equipment, LocalDate validityEndDate)	Fetch a single EquipmentStrucList entity using key fields.
String	getServicePath()
DefaultEquipmentHierarchyService	withServicePath(String servicePath)	Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultEquipmentHierarchyService

public DefaultEquipmentHierarchyService()

Creates a service using EquipmentHierarchyService.DEFAULT_SERVICE_PATH to send the requests.

Method Details

withServicePath

@Nonnull
public DefaultEquipmentHierarchyService withServicePath(@Nonnull
 String servicePath)

Description copied from interface: EquipmentHierarchyService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface EquipmentHierarchyService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: EquipmentHierarchyService

Creates a batch request builder object.

Specified by:

batch in interface EquipmentHierarchyService

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllEquipmentStructureList

@Nonnull
public GetAllRequestBuilder<EquipmentStrucList> getAllEquipmentStructureList()

Description copied from interface: EquipmentHierarchyService

Fetch multiple EquipmentStrucList entities.

Specified by:

getAllEquipmentStructureList in interface EquipmentHierarchyService

Returns:

A request builder to fetch multiple EquipmentStrucList entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countEquipmentStructureList

@Nonnull
public CountRequestBuilder<EquipmentStrucList> countEquipmentStructureList()

Description copied from interface: EquipmentHierarchyService

Fetch the number of entries from the EquipmentStrucList entity collection matching the filter and search expressions.

Specified by:

countEquipmentStructureList in interface EquipmentHierarchyService

Returns:

A request builder to fetch the count of EquipmentStrucList entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getEquipmentStructureListByKey

@Nonnull
public GetByKeyRequestBuilder<EquipmentStrucList> getEquipmentStructureListByKey(String equipment,
 LocalDate validityEndDate)

Description copied from interface: EquipmentHierarchyService

Fetch a single EquipmentStrucList entity using key fields.

Specified by:

getEquipmentStructureListByKey in interface EquipmentHierarchyService

Parameters:

equipment - Equipment Number

Constraints: Not nullable, Maximum length: 18

validityEndDate - Valid To Date

Constraints: Not nullable

Returns:

A request builder to fetch a single EquipmentStrucList entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getServicePath

@Nonnull
public String getServicePath()

Specified by:

getServicePath in interface ServiceWithNavigableEntities