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

Interface CatalogTypeCauseService

All Known Implementing Classes:

DefaultCatalogTypeCauseService

@Deprecated
public interface CatalogTypeCauseService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service contains catalog groups and codes that belong to catalog type 5 which is Cause. The catalog type Cause is used in maintenance notification item level to record the cause of a failure in the asset. If the input in the request is not as expected then, the system displays appropriate error or warning messages in the response. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	APICAUSE_0001
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Maintenance Processing Integration(SAP_COM_0397)
Scope Items:	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), Improvement Maintenance(OVT), Operational and Overhead Maintenance(OWM)
Authentication Methods:	x509
Service Group Name:	API_CAUSE
Business Object:	Maintenance Notification

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<CauseCode>	countMaintNotifCauseCode()	Deprecated. Fetch the number of entries from the CauseCode entity collection matching the filter and search expressions.
GetAllRequestBuilder<CauseCode>	getAllMaintNotifCauseCode()	Deprecated. Fetch multiple CauseCode entities.
GetByKeyRequestBuilder<CauseCode>	getMaintNotifCauseCodeByKey(String maintNotifCauseCatalog, String maintNotifCauseCodeGroup, String maintNotificationCauseCode)	Deprecated. Fetch a single CauseCode entity using key fields.
CatalogTypeCauseService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Field Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

• Constant Field Values

Method Details

withServicePath

@Nonnull
CatalogTypeCauseService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
BatchRequestBuilder batch()

Deprecated.

Creates a batch request builder object.

Returns:

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

getAllMaintNotifCauseCode

@Nonnull
GetAllRequestBuilder<CauseCode> getAllMaintNotifCauseCode()

Deprecated.

Fetch multiple CauseCode entities.

Returns:

A request builder to fetch multiple CauseCode 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.

countMaintNotifCauseCode

@Nonnull
CountRequestBuilder<CauseCode> countMaintNotifCauseCode()

Deprecated.

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

Returns:

A request builder to fetch the count of CauseCode 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.

getMaintNotifCauseCodeByKey

@Nonnull
GetByKeyRequestBuilder<CauseCode> getMaintNotifCauseCodeByKey(String maintNotifCauseCatalog,
 String maintNotifCauseCodeGroup,
 String maintNotificationCauseCode)

Deprecated.

Fetch a single CauseCode entity using key fields.

Parameters:

maintNotifCauseCodeGroup - Code Group

Constraints: Not nullable, Maximum length: 8

maintNotifCauseCatalog - Catalog

Constraints: Not nullable, Maximum length: 1

maintNotificationCauseCode - Code

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single CauseCode 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.