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

Interface MaintenanceItemService

All Superinterfaces:
BatchService<MaintenanceItemServiceBatch>
All Known Implementing Classes:
DefaultMaintenanceItemService
@Deprecated public interface MaintenanceItemService extends BatchService<MaintenanceItemServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This API allows you to read, create, and update maintenance items. The request contains all the information that is necessary to read, create, and update maintenance items. 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 Business Accelerator Hub

Details:

OData Service: API_MAINTENANCEITEM
API Version: 1.3.0
Minimum ERP Version: 2302
Communication Scenario: Maintenance Planning Integration(SAP_COM_0396)
Scope Items: Service Order Management and Monitoring(3D2), 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), Recurring Services(4X5)
Authentication Methods: x509
Business Object: Maintenance Item

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull MaintenanceItemService 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.

    • getAllMaintenanceItem

      @Nonnull MaintenanceItemFluentHelper getAllMaintenanceItem()
      Deprecated.
      Fetch multiple MaintenanceItem entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemByKey

      @Nonnull MaintenanceItemByKeyFluentHelper getMaintenanceItemByKey(String maintenanceItem)
      Deprecated.
      Fetch a single MaintenanceItem entity using key fields.
      Parameters:
      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

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

    • createMaintenanceItem

      @Nonnull MaintenanceItemCreateFluentHelper createMaintenanceItem(@Nonnull MaintenanceItem maintenanceItem)
      Deprecated.
      Create a new MaintenanceItem entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItem - MaintenanceItem entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new MaintenanceItem entity. To perform execution, call the execute method on the fluent helper object.

    • updateMaintenanceItem

      @Nonnull MaintenanceItemUpdateFluentHelper updateMaintenanceItem(@Nonnull MaintenanceItem maintenanceItem)
      Deprecated.
      Update an existing MaintenanceItem entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItem - MaintenanceItem entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItem entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenanceItemCause

      @Nonnull MaintenanceItemCauseFluentHelper getAllMaintenanceItemCause()
      Deprecated.
      Fetch multiple MaintenanceItemCause entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItemCause entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemCauseByKey

      @Nonnull MaintenanceItemCauseByKeyFluentHelper getMaintenanceItemCauseByKey(String maintenanceItem, String nmbrOfMaintComplianceItems)
      Deprecated.
      Fetch a single MaintenanceItemCause entity using key fields.
      Parameters:
      nmbrOfMaintComplianceItems - Sequential Number for Compliance

      Constraints: Not nullable, Maximum length: 4

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

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

    • createMaintenanceItemCause

      @Nonnull MaintenanceItemCauseCreateFluentHelper createMaintenanceItemCause(@Nonnull MaintenanceItemCause maintenanceItemCause)
      Deprecated.
      Create a new MaintenanceItemCause entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemCause - MaintenanceItemCause entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new MaintenanceItemCause entity. To perform execution, call the execute method on the fluent helper object.

    • updateMaintenanceItemCause

      @Nonnull MaintenanceItemCauseUpdateFluentHelper updateMaintenanceItemCause(@Nonnull MaintenanceItemCause maintenanceItemCause)
      Deprecated.
      Update an existing MaintenanceItemCause entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemCause - MaintenanceItemCause entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItemCause entity. To perform execution, call the execute method on the fluent helper object.

    • deleteMaintenanceItemCause

      @Nonnull MaintenanceItemCauseDeleteFluentHelper deleteMaintenanceItemCause(@Nonnull MaintenanceItemCause maintenanceItemCause)
      Deprecated.
      Deletes an existing MaintenanceItemCause entity in the S/4HANA system.
      Parameters:
      maintenanceItemCause - MaintenanceItemCause entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing MaintenanceItemCause entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenanceItemCauseText

      @Nonnull MaintenanceItemCauseTextFluentHelper getAllMaintenanceItemCauseText()
      Deprecated.
      Fetch multiple MaintenanceItemCauseText entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItemCauseText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemCauseTextByKey

      @Nonnull MaintenanceItemCauseTextByKeyFluentHelper getMaintenanceItemCauseTextByKey(String maintenanceItem, String nmbrOfMaintComplianceItems, String language)
      Deprecated.
      Fetch a single MaintenanceItemCauseText entity using key fields.
      Parameters:
      nmbrOfMaintComplianceItems - Sequential Number for Compliance

      Constraints: Not nullable, Maximum length: 4

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

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

    • updateMaintenanceItemCauseText

      @Nonnull MaintenanceItemCauseTextUpdateFluentHelper updateMaintenanceItemCauseText(@Nonnull MaintenanceItemCauseText maintenanceItemCauseText)
      Deprecated.
      Update an existing MaintenanceItemCauseText entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemCauseText - MaintenanceItemCauseText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItemCauseText entity. To perform execution, call the execute method on the fluent helper object.

    • deleteMaintenanceItemCauseText

      @Nonnull MaintenanceItemCauseTextDeleteFluentHelper deleteMaintenanceItemCauseText(@Nonnull MaintenanceItemCauseText maintenanceItemCauseText)
      Deprecated.
      Deletes an existing MaintenanceItemCauseText entity in the S/4HANA system.
      Parameters:
      maintenanceItemCauseText - MaintenanceItemCauseText entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing MaintenanceItemCauseText entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenanceItemReason

      @Nonnull MaintenanceItemReasonFluentHelper getAllMaintenanceItemReason()
      Deprecated.
      Fetch multiple MaintenanceItemReason entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItemReason entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemReasonByKey

      @Nonnull MaintenanceItemReasonByKeyFluentHelper getMaintenanceItemReasonByKey(String maintenanceItem, String nmbrOfMaintComplianceItems)
      Deprecated.
      Fetch a single MaintenanceItemReason entity using key fields.
      Parameters:
      nmbrOfMaintComplianceItems - Sequential Number for Compliance

      Constraints: Not nullable, Maximum length: 4

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

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

    • createMaintenanceItemReason

      @Nonnull MaintenanceItemReasonCreateFluentHelper createMaintenanceItemReason(@Nonnull MaintenanceItemReason maintenanceItemReason)
      Deprecated.
      Create a new MaintenanceItemReason entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemReason - MaintenanceItemReason entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new MaintenanceItemReason entity. To perform execution, call the execute method on the fluent helper object.

    • updateMaintenanceItemReason

      @Nonnull MaintenanceItemReasonUpdateFluentHelper updateMaintenanceItemReason(@Nonnull MaintenanceItemReason maintenanceItemReason)
      Deprecated.
      Update an existing MaintenanceItemReason entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemReason - MaintenanceItemReason entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItemReason entity. To perform execution, call the execute method on the fluent helper object.

    • deleteMaintenanceItemReason

      @Nonnull MaintenanceItemReasonDeleteFluentHelper deleteMaintenanceItemReason(@Nonnull MaintenanceItemReason maintenanceItemReason)
      Deprecated.
      Deletes an existing MaintenanceItemReason entity in the S/4HANA system.
      Parameters:
      maintenanceItemReason - MaintenanceItemReason entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing MaintenanceItemReason entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenanceItemReasonText

      @Nonnull MaintenanceItemReasonTextFluentHelper getAllMaintenanceItemReasonText()
      Deprecated.
      Fetch multiple MaintenanceItemReasonText entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItemReasonText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemReasonTextByKey

      @Nonnull MaintenanceItemReasonTextByKeyFluentHelper getMaintenanceItemReasonTextByKey(String maintenanceItem, String nmbrOfMaintComplianceItems, String language)
      Deprecated.
      Fetch a single MaintenanceItemReasonText entity using key fields.
      Parameters:
      nmbrOfMaintComplianceItems - Sequential Number for Compliance

      Constraints: Not nullable, Maximum length: 4

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

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

    • updateMaintenanceItemReasonText

      @Nonnull MaintenanceItemReasonTextUpdateFluentHelper updateMaintenanceItemReasonText(@Nonnull MaintenanceItemReasonText maintenanceItemReasonText)
      Deprecated.
      Update an existing MaintenanceItemReasonText entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemReasonText - MaintenanceItemReasonText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItemReasonText entity. To perform execution, call the execute method on the fluent helper object.

    • deleteMaintenanceItemReasonText

      @Nonnull MaintenanceItemReasonTextDeleteFluentHelper deleteMaintenanceItemReasonText(@Nonnull MaintenanceItemReasonText maintenanceItemReasonText)
      Deprecated.
      Deletes an existing MaintenanceItemReasonText entity in the S/4HANA system.
      Parameters:
      maintenanceItemReasonText - MaintenanceItemReasonText entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing MaintenanceItemReasonText entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenanceItemText

      @Nonnull MaintenanceItemTextFluentHelper getAllMaintenanceItemText()
      Deprecated.
      Fetch multiple MaintenanceItemText entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceItemText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenanceItemTextByKey

      @Nonnull MaintenanceItemTextByKeyFluentHelper getMaintenanceItemTextByKey(String maintenanceItem, String language)
      Deprecated.
      Fetch a single MaintenanceItemText entity using key fields.
      Parameters:
      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

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

    • updateMaintenanceItemText

      @Nonnull MaintenanceItemTextUpdateFluentHelper updateMaintenanceItemText(@Nonnull MaintenanceItemText maintenanceItemText)
      Deprecated.
      Update an existing MaintenanceItemText entity and save it to the S/4HANA system.
      Parameters:
      maintenanceItemText - MaintenanceItemText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintenanceItemText entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintItemObjectListItem

      @Nonnull MaintItemObjectListItemFluentHelper getAllMaintItemObjectListItem()
      Deprecated.
      Fetch multiple MaintItemObjectListItem entities.
      Returns:
      A fluent helper to fetch multiple MaintItemObjectListItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintItemObjectListItemByKey

      @Nonnull MaintItemObjectListItemByKeyFluentHelper getMaintItemObjectListItemByKey(String maintenanceItem, Long maintenanceItemObjectList, Integer maintenanceObjectListItem)
      Deprecated.
      Fetch a single MaintItemObjectListItem entity using key fields.
      Parameters:
      maintenanceItemObjectList - Object list number

      Constraints: Not nullable

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

      maintenanceObjectListItem - Object list counters

      Constraints: Not nullable

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

    • updateMaintItemObjectListItem

      @Nonnull MaintItemObjectListItemUpdateFluentHelper updateMaintItemObjectListItem(@Nonnull MaintItemObjectListItem maintItemObjectListItem)
      Deprecated.
      Update an existing MaintItemObjectListItem entity and save it to the S/4HANA system.
      Parameters:
      maintItemObjectListItem - MaintItemObjectListItem entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing MaintItemObjectListItem entity. To perform execution, call the execute method on the fluent helper object.

    • deleteMaintItemObjectListItem

      @Nonnull MaintItemObjectListItemDeleteFluentHelper deleteMaintItemObjectListItem(@Nonnull MaintItemObjectListItem maintItemObjectListItem)
      Deprecated.
      Deletes an existing MaintItemObjectListItem entity in the S/4HANA system.
      Parameters:
      maintItemObjectListItem - MaintItemObjectListItem entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing MaintItemObjectListItem entity. To perform execution, call the execute method on the fluent helper object.

    • getAllMaintenancePlanCallObject

      @Nonnull MaintenancePlanCallObjectFluentHelper getAllMaintenancePlanCallObject()
      Deprecated.
      Fetch multiple MaintenancePlanCallObject entities.
      Returns:
      A fluent helper to fetch multiple MaintenancePlanCallObject entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getMaintenancePlanCallObjectByKey

      @Nonnull MaintenancePlanCallObjectByKeyFluentHelper getMaintenancePlanCallObjectByKey(String maintenancePlan, Integer maintenancePlanCallNumber, String maintenanceItem)
      Deprecated.
      Fetch a single MaintenancePlanCallObject entity using key fields.
      Parameters:
      maintenancePlanCallNumber - Maintenance Plan Call Number

      Constraints: Not nullable

      maintenancePlan - Maintenance Plan

      Constraints: Not nullable, Maximum length: 12

      maintenanceItem - Maintenance Item

      Constraints: Not nullable, Maximum length: 16

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