MaintenancePlanService (SAP S/4HANA On-Premise - OData VDM

All Superinterfaces:

BatchService<MaintenancePlanServiceBatch>

All Known Implementing Classes:

DefaultMaintenancePlanService
```
public interface MaintenancePlanService
extends BatchService<MaintenancePlanServiceBatch>
```
This API allows you to read, create, and update maintenance plans. It contains maintenance plans, schedules, maintenance items, maintenance cycles and classification details. The request contains all the information that is necessary to read, create, and update maintenance plans. 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: OP_API_MAINTENANCEPLAN_0001

API Version: 1

Minimum ERP Version: 2021

Authentication Methods: Basic, x509

Business Object: Maintenance Plan

Field Summary

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssignMaintItemToMaintPlanFluentHelper`	`assignMaintItemToMaintPlan(String maintenancePlan, String maintenanceitem)` Creates a fluent helper for the AssignMaintItemToMaintPlan OData function import.
`MaintenanceItemCreateFluentHelper`	`createMaintenanceItem(MaintenanceItem maintenanceItem)` Create a new `MaintenanceItem` entity and save it to the S/4HANA system.
`MaintenancePlanCreateFluentHelper`	`createMaintenancePlan(MaintenancePlan maintenancePlan)` Create a new `MaintenancePlan` entity and save it to the S/4HANA system.
`MaintItemObjectListItemDeleteFluentHelper`	`deleteMaintItemObjectListItem(MaintItemObjectListItem maintItemObjectListItem)` Deletes an existing `MaintItemObjectListItem` entity in the S/4HANA system.
`MaintenanceItemFluentHelper`	`getAllMaintenanceItem()` Fetch multiple `MaintenanceItem` entities.
`MaintenanceItemCauseFluentHelper`	`getAllMaintenanceItemCause()` Fetch multiple `MaintenanceItemCause` entities.
`MaintenanceItemCauseTextFluentHelper`	`getAllMaintenanceItemCauseText()` Fetch multiple `MaintenanceItemCauseText` entities.
`MaintenanceItemReasonFluentHelper`	`getAllMaintenanceItemReason()` Fetch multiple `MaintenanceItemReason` entities.
`MaintenanceItemReasonTextFluentHelper`	`getAllMaintenanceItemReasonText()` Fetch multiple `MaintenanceItemReasonText` entities.
`MaintenanceItemTextFluentHelper`	`getAllMaintenanceItemText()` Fetch multiple `MaintenanceItemText` entities.
`MaintenancePlanFluentHelper`	`getAllMaintenancePlan()` Fetch multiple `MaintenancePlan` entities.
`MaintenancePlanCallObjectFluentHelper`	`getAllMaintenancePlanCallObject()` Fetch multiple `MaintenancePlanCallObject` entities.
`MaintenancePlanCycleFluentHelper`	`getAllMaintenancePlanCycle()` Fetch multiple `MaintenancePlanCycle` entities.
`MaintenancePlanScheduleFluentHelper`	`getAllMaintenancePlanSchedule()` Fetch multiple `MaintenancePlanSchedule` entities.
`MaintenancePlanStrategyCycleFluentHelper`	`getAllMaintenancePlanStrategyCycle()` Fetch multiple `MaintenancePlanStrategyCycle` entities.
`MaintenancePlanTextFluentHelper`	`getAllMaintenancePlanText()` Fetch multiple `MaintenancePlanText` entities.
`MaintItemObjectListItemFluentHelper`	`getAllMaintItemObjectListItem()` Fetch multiple `MaintItemObjectListItem` entities.
`MaintPlanClfnCharValueFluentHelper`	`getAllMaintPlanClfnCharValue()` Fetch multiple `MaintPlanClfnCharValue` entities.
`MaintPlanClfnClassFluentHelper`	`getAllMaintPlanClfnClass()` Fetch multiple `MaintPlanClfnClass` entities.
`MaintPlanClfnClassCharFluentHelper`	`getAllMaintPlanClfnClassChar()` Fetch multiple `MaintPlanClfnClassChar` entities.
`MaintenanceItemByKeyFluentHelper`	`getMaintenanceItemByKey(String maintenanceItem)` Fetch a single `MaintenanceItem` entity using key fields.
`MaintenanceItemCauseByKeyFluentHelper`	`getMaintenanceItemCauseByKey(String maintenanceItem, String nmbrOfMaintComplianceItems)` Fetch a single `MaintenanceItemCause` entity using key fields.
`MaintenanceItemCauseTextByKeyFluentHelper`	`getMaintenanceItemCauseTextByKey(String maintenanceItem, String nmbrOfMaintComplianceItems, String language)` Fetch a single `MaintenanceItemCauseText` entity using key fields.
`MaintenanceItemReasonByKeyFluentHelper`	`getMaintenanceItemReasonByKey(String maintenanceItem, String nmbrOfMaintComplianceItems)` Fetch a single `MaintenanceItemReason` entity using key fields.
`MaintenanceItemReasonTextByKeyFluentHelper`	`getMaintenanceItemReasonTextByKey(String maintenanceItem, String nmbrOfMaintComplianceItems, String language)` Fetch a single `MaintenanceItemReasonText` entity using key fields.
`MaintenanceItemTextByKeyFluentHelper`	`getMaintenanceItemTextByKey(String maintenanceItem, String language)` Fetch a single `MaintenanceItemText` entity using key fields.
`MaintenancePlanByKeyFluentHelper`	`getMaintenancePlanByKey(String maintenancePlan)` Fetch a single `MaintenancePlan` entity using key fields.
`MaintenancePlanCallObjectByKeyFluentHelper`	`getMaintenancePlanCallObjectByKey(String maintenancePlan, Integer maintenancePlanCallNumber, String maintenanceItem)` Fetch a single `MaintenancePlanCallObject` entity using key fields.
`MaintenancePlanCycleByKeyFluentHelper`	`getMaintenancePlanCycleByKey(String maintenancePlan, String maintenancePlanCycle)` Fetch a single `MaintenancePlanCycle` entity using key fields.
`MaintenancePlanScheduleByKeyFluentHelper`	`getMaintenancePlanScheduleByKey(String maintenancePlan, Integer maintenancePlanCallNumber, String maintenancePackage)` Fetch a single `MaintenancePlanSchedule` entity using key fields.
`MaintenancePlanStrategyCycleByKeyFluentHelper`	`getMaintenancePlanStrategyCycleByKey(String maintenancePlan, String maintenancePlanCycle)` Fetch a single `MaintenancePlanStrategyCycle` entity using key fields.
`MaintenancePlanTextByKeyFluentHelper`	`getMaintenancePlanTextByKey(String maintenancePlan, String language)` Fetch a single `MaintenancePlanText` entity using key fields.
`MaintItemObjectListItemByKeyFluentHelper`	`getMaintItemObjectListItemByKey(String maintenanceItem, Long maintenanceItemObjectList, Integer maintenanceObjectListItem)` Fetch a single `MaintItemObjectListItem` entity using key fields.
`MaintPlanClfnCharValueByKeyFluentHelper`	`getMaintPlanClfnCharValueByKey(String maintenancePlan, String classType, String clfnCharcValuePositionNumber, String charcInternalID)` Fetch a single `MaintPlanClfnCharValue` entity using key fields.
`MaintPlanClfnClassByKeyFluentHelper`	`getMaintPlanClfnClassByKey(String maintenancePlan, String classInternalID, String classType)` Fetch a single `MaintPlanClfnClass` entity using key fields.
`MaintPlanClfnClassCharByKeyFluentHelper`	`getMaintPlanClfnClassCharByKey(String maintenancePlan, String classInternalID, String charcInternalID)` Fetch a single `MaintPlanClfnClassChar` entity using key fields.
`RestartMaintPlnScheduleFluentHelper`	`restartMaintPlnSchedule(String maintenancePlan, LocalDateTime schedulingStartDate, LocalTime schedulingStartTime, String maintPlanStartCntrReadingValue, Boolean maintPlanSchedFutrCallsAreKept)` Creates a fluent helper for the RestartMaintPlnSchedule OData function import.
`StartMaintPlnScheduleFluentHelper`	`startMaintPlnSchedule(String maintenancePlan, LocalDateTime schedulingStartDate, LocalTime schedulingStartTime, String maintPlanStartCntrReadingValue, LocalDateTime maintPlnSchedgCallObjUpToDte)` Creates a fluent helper for the StartMaintPlnSchedule OData function import.
`MaintenanceItemUpdateFluentHelper`	`updateMaintenanceItem(MaintenanceItem maintenanceItem)` Update an existing `MaintenanceItem` entity and save it to the S/4HANA system.
`MaintenanceItemTextUpdateFluentHelper`	`updateMaintenanceItemText(MaintenanceItemText maintenanceItemText)` Update an existing `MaintenanceItemText` entity and save it to the S/4HANA system.
`MaintenancePlanUpdateFluentHelper`	`updateMaintenancePlan(MaintenancePlan maintenancePlan)` Update an existing `MaintenancePlan` entity and save it to the S/4HANA system.
`MaintenancePlanCycleUpdateFluentHelper`	`updateMaintenancePlanCycle(MaintenancePlanCycle maintenancePlanCycle)` Update an existing `MaintenancePlanCycle` entity and save it to the S/4HANA system.
`MaintenancePlanTextUpdateFluentHelper`	`updateMaintenancePlanText(MaintenancePlanText maintenancePlanText)` Update an existing `MaintenancePlanText` entity and save it to the S/4HANA system.
`MaintItemObjectListItemUpdateFluentHelper`	`updateMaintItemObjectListItem(MaintItemObjectListItem maintItemObjectListItem)` Update an existing `MaintItemObjectListItem` entity and save it to the S/4HANA system.
`MaintenancePlanService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService
batch

- Field Detail
  - DEFAULT_SERVICE_PATH
```
static final String DEFAULT_SERVICE_PATH
```
    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 Detail
  - withServicePath
```
@Nonnull
MaintenancePlanService withServicePath(@Nonnull
                                                String servicePath)
```
    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()
```
    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)
```
    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)
```
    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)
```
    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()
```
    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)
```
    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.
  - getAllMaintenanceItemCauseText
```
@Nonnull
MaintenanceItemCauseTextFluentHelper getAllMaintenanceItemCauseText()
```
    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)
```
    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 -
    
    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.
  - getAllMaintenanceItemReason
```
@Nonnull
MaintenanceItemReasonFluentHelper getAllMaintenanceItemReason()
```
    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)
```
    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.
  - getAllMaintenanceItemReasonText
```
@Nonnull
MaintenanceItemReasonTextFluentHelper getAllMaintenanceItemReasonText()
```
    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)
```
    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 -
    
    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.
  - getAllMaintenanceItemText
```
@Nonnull
MaintenanceItemTextFluentHelper getAllMaintenanceItemText()
```
    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)
```
    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)
```
    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.
  - getAllMaintenancePlan
```
@Nonnull
MaintenancePlanFluentHelper getAllMaintenancePlan()
```
    Fetch multiple MaintenancePlan entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintenancePlan 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.
  - getMaintenancePlanByKey
```
@Nonnull
MaintenancePlanByKeyFluentHelper getMaintenancePlanByKey(String maintenancePlan)
```
    Fetch a single MaintenancePlan entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    Returns:
    
    A fluent helper to fetch a single MaintenancePlan 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.
  - createMaintenancePlan
```
@Nonnull
MaintenancePlanCreateFluentHelper createMaintenancePlan(@Nonnull
                                                                 MaintenancePlan maintenancePlan)
```
    Create a new MaintenancePlan entity and save it to the S/4HANA system.
    
    Parameters:
    
    maintenancePlan - MaintenancePlan entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new MaintenancePlan entity. To perform execution, call the execute method on the fluent helper object.
  - updateMaintenancePlan
```
@Nonnull
MaintenancePlanUpdateFluentHelper updateMaintenancePlan(@Nonnull
                                                                 MaintenancePlan maintenancePlan)
```
    Update an existing MaintenancePlan entity and save it to the S/4HANA system.
    
    Parameters:
    
    maintenancePlan - MaintenancePlan entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing MaintenancePlan entity. To perform execution, call the execute method on the fluent helper object.
  - getAllMaintenancePlanCycle
```
@Nonnull
MaintenancePlanCycleFluentHelper getAllMaintenancePlanCycle()
```
    Fetch multiple MaintenancePlanCycle entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintenancePlanCycle 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.
  - getMaintenancePlanCycleByKey
```
@Nonnull
MaintenancePlanCycleByKeyFluentHelper getMaintenancePlanCycleByKey(String maintenancePlan,
                                                                            String maintenancePlanCycle)
```
    Fetch a single MaintenancePlanCycle entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    maintenancePlanCycle - Counter in Control Tables
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single MaintenancePlanCycle 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.
  - updateMaintenancePlanCycle
```
@Nonnull
MaintenancePlanCycleUpdateFluentHelper updateMaintenancePlanCycle(@Nonnull
                                                                           MaintenancePlanCycle maintenancePlanCycle)
```
    Update an existing MaintenancePlanCycle entity and save it to the S/4HANA system.
    
    Parameters:
    
    maintenancePlanCycle - MaintenancePlanCycle entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing MaintenancePlanCycle entity. To perform execution, call the execute method on the fluent helper object.
  - getAllMaintenancePlanSchedule
```
@Nonnull
MaintenancePlanScheduleFluentHelper getAllMaintenancePlanSchedule()
```
    Fetch multiple MaintenancePlanSchedule entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintenancePlanSchedule 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.
  - getMaintenancePlanScheduleByKey
```
@Nonnull
MaintenancePlanScheduleByKeyFluentHelper getMaintenancePlanScheduleByKey(String maintenancePlan,
                                                                                  Integer maintenancePlanCallNumber,
                                                                                  String maintenancePackage)
```
    Fetch a single MaintenancePlanSchedule entity using key fields.
    
    Parameters:
    
    maintenancePlanCallNumber - Maintenance Plan Call Number
    Constraints: Not nullable
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    maintenancePackage - Maintenance Package Number
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single MaintenancePlanSchedule 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.
  - getAllMaintenancePlanText
```
@Nonnull
MaintenancePlanTextFluentHelper getAllMaintenancePlanText()
```
    Fetch multiple MaintenancePlanText entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintenancePlanText 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.
  - getMaintenancePlanTextByKey
```
@Nonnull
MaintenancePlanTextByKeyFluentHelper getMaintenancePlanTextByKey(String maintenancePlan,
                                                                          String language)
```
    Fetch a single MaintenancePlanText entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    language - Language Key
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single MaintenancePlanText 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.
  - updateMaintenancePlanText
```
@Nonnull
MaintenancePlanTextUpdateFluentHelper updateMaintenancePlanText(@Nonnull
                                                                         MaintenancePlanText maintenancePlanText)
```
    Update an existing MaintenancePlanText entity and save it to the S/4HANA system.
    
    Parameters:
    
    maintenancePlanText - MaintenancePlanText entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing MaintenancePlanText entity. To perform execution, call the execute method on the fluent helper object.
  - getAllMaintItemObjectListItem
```
@Nonnull
MaintItemObjectListItemFluentHelper getAllMaintItemObjectListItem()
```
    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)
```
    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)
```
    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)
```
    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()
```
    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)
```
    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.
  - getAllMaintPlanClfnCharValue
```
@Nonnull
MaintPlanClfnCharValueFluentHelper getAllMaintPlanClfnCharValue()
```
    Fetch multiple MaintPlanClfnCharValue entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintPlanClfnCharValue 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.
  - getMaintPlanClfnCharValueByKey
```
@Nonnull
MaintPlanClfnCharValueByKeyFluentHelper getMaintPlanClfnCharValueByKey(String maintenancePlan,
                                                                                String classType,
                                                                                String clfnCharcValuePositionNumber,
                                                                                String charcInternalID)
```
    Fetch a single MaintPlanClfnCharValue entity using key fields.
    
    Parameters:
    
    clfnCharcValuePositionNumber - Characteristic value counter
    Constraints: Not nullable, Maximum length: 3
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    charcInternalID - Characteristic Internal ID
    Constraints: Not nullable, Maximum length: 10
    
    classType - Class Type
    Constraints: Not nullable, Maximum length: 3
    
    Returns:
    
    A fluent helper to fetch a single MaintPlanClfnCharValue 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.
  - getAllMaintPlanClfnClass
```
@Nonnull
MaintPlanClfnClassFluentHelper getAllMaintPlanClfnClass()
```
    Fetch multiple MaintPlanClfnClass entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintPlanClfnClass 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.
  - getMaintPlanClfnClassByKey
```
@Nonnull
MaintPlanClfnClassByKeyFluentHelper getMaintPlanClfnClassByKey(String maintenancePlan,
                                                                        String classInternalID,
                                                                        String classType)
```
    Fetch a single MaintPlanClfnClass entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    classInternalID - Internal Class Number
    Constraints: Not nullable, Maximum length: 10
    
    classType - Class Type
    Constraints: Not nullable, Maximum length: 3
    
    Returns:
    
    A fluent helper to fetch a single MaintPlanClfnClass 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.
  - getAllMaintPlanClfnClassChar
```
@Nonnull
MaintPlanClfnClassCharFluentHelper getAllMaintPlanClfnClassChar()
```
    Fetch multiple MaintPlanClfnClassChar entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintPlanClfnClassChar 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.
  - getMaintPlanClfnClassCharByKey
```
@Nonnull
MaintPlanClfnClassCharByKeyFluentHelper getMaintPlanClfnClassCharByKey(String maintenancePlan,
                                                                                String classInternalID,
                                                                                String charcInternalID)
```
    Fetch a single MaintPlanClfnClassChar entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    charcInternalID - Characteristic Internal ID
    Constraints: Not nullable, Maximum length: 10
    
    classInternalID - Internal Class Number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single MaintPlanClfnClassChar 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.
  - getAllMaintenancePlanStrategyCycle
```
@Nonnull
MaintenancePlanStrategyCycleFluentHelper getAllMaintenancePlanStrategyCycle()
```
    Fetch multiple MaintenancePlanStrategyCycle entities.
    
    Returns:
    
    A fluent helper to fetch multiple MaintenancePlanStrategyCycle 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.
  - getMaintenancePlanStrategyCycleByKey
```
@Nonnull
MaintenancePlanStrategyCycleByKeyFluentHelper getMaintenancePlanStrategyCycleByKey(String maintenancePlan,
                                                                                            String maintenancePlanCycle)
```
    Fetch a single MaintenancePlanStrategyCycle entity using key fields.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    Constraints: Not nullable, Maximum length: 12
    
    maintenancePlanCycle - Counter in Control Tables
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single MaintenancePlanStrategyCycle 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.
  - assignMaintItemToMaintPlan
```
@Nonnull
AssignMaintItemToMaintPlanFluentHelper assignMaintItemToMaintPlan(@Nonnull
                                                                           String maintenancePlan,
                                                                           @Nonnull
                                                                           String maintenanceitem)
```
    Creates a fluent helper for the AssignMaintItemToMaintPlan OData function import.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    
    Constraints: Not nullable, Maximum length: 12
    
    Original parameter name from the Odata EDM: MaintenancePlan
    
    maintenanceitem - Maintenance Item
    
    Constraints: Not nullable, Maximum length: 16
    
    Original parameter name from the Odata EDM: Maintenanceitem
    
    Returns:
    
    A fluent helper object that will execute the AssignMaintItemToMaintPlan OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - restartMaintPlnSchedule
```
@Nonnull
RestartMaintPlnScheduleFluentHelper restartMaintPlnSchedule(@Nonnull
                                                                     String maintenancePlan,
                                                                     @Nullable
                                                                     LocalDateTime schedulingStartDate,
                                                                     @Nullable
                                                                     LocalTime schedulingStartTime,
                                                                     @Nullable
                                                                     String maintPlanStartCntrReadingValue,
                                                                     @Nullable
                                                                     Boolean maintPlanSchedFutrCallsAreKept)
```
    Creates a fluent helper for the RestartMaintPlnSchedule OData function import.
    
    Parameters:
    
    maintPlanSchedFutrCallsAreKept - Boolean Variable (X = True, - = False, Space = Unknown)
    
    Constraints: Nullable
    
    Original parameter name from the Odata EDM: MaintPlanSchedFutrCallsAreKept
    
    maintenancePlan - Maintenance Plan
    
    Constraints: Not nullable, Maximum length: 12
    
    Original parameter name from the Odata EDM: MaintenancePlan
    
    schedulingStartDate - Start of cycle
    
    Constraints: Nullable, Precision: 0
    
    Original parameter name from the Odata EDM: SchedulingStartDate
    
    schedulingStartTime - Start Time
    
    Constraints: Nullable, Precision: 0
    
    Original parameter name from the Odata EDM: SchedulingStartTime
    
    maintPlanStartCntrReadingValue - StartCounterReading
    
    Constraints: Nullable, Maximum length: 22
    
    Original parameter name from the Odata EDM: MaintPlanStartCntrReadingValue
    
    Returns:
    
    A fluent helper object that will execute the RestartMaintPlnSchedule OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - startMaintPlnSchedule
```
@Nonnull
StartMaintPlnScheduleFluentHelper startMaintPlnSchedule(@Nonnull
                                                                 String maintenancePlan,
                                                                 @Nullable
                                                                 LocalDateTime schedulingStartDate,
                                                                 @Nullable
                                                                 LocalTime schedulingStartTime,
                                                                 @Nullable
                                                                 String maintPlanStartCntrReadingValue,
                                                                 @Nullable
                                                                 LocalDateTime maintPlnSchedgCallObjUpToDte)
```
    Creates a fluent helper for the StartMaintPlnSchedule OData function import.
    
    Parameters:
    
    maintenancePlan - Maintenance Plan
    
    Constraints: Not nullable, Maximum length: 12
    
    Original parameter name from the Odata EDM: MaintenancePlan
    
    schedulingStartDate - Start of cycle
    
    Constraints: Nullable, Precision: 0
    
    Original parameter name from the Odata EDM: SchedulingStartDate
    
    schedulingStartTime - Start Time
    
    Constraints: Nullable, Precision: 0
    
    Original parameter name from the Odata EDM: SchedulingStartTime
    
    maintPlanStartCntrReadingValue - StartCounterReading
    
    Constraints: Nullable, Maximum length: 22
    
    Original parameter name from the Odata EDM: MaintPlanStartCntrReadingValue
    
    maintPlnSchedgCallObjUpToDte - Current Date
    
    Constraints: Nullable, Precision: 0
    
    Original parameter name from the Odata EDM: MaintPlnSchedgCallObjUpToDte
    
    Returns:
    
    A fluent helper object that will execute the StartMaintPlnSchedule OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

OData Service:	OP_API_MAINTENANCEPLAN_0001
API Version:	1
Minimum ERP Version:	2021
Authentication Methods:	Basic, x509
Business Object:	Maintenance Plan

Interface MaintenancePlanService

Details:

Field Summary

Method Summary

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllMaintenanceItem

getMaintenanceItemByKey

createMaintenanceItem

updateMaintenanceItem

getAllMaintenanceItemCause

getMaintenanceItemCauseByKey

getAllMaintenanceItemCauseText

getMaintenanceItemCauseTextByKey

getAllMaintenanceItemReason

getMaintenanceItemReasonByKey

getAllMaintenanceItemReasonText

getMaintenanceItemReasonTextByKey

getAllMaintenanceItemText

getMaintenanceItemTextByKey

updateMaintenanceItemText

getAllMaintenancePlan

getMaintenancePlanByKey

createMaintenancePlan

updateMaintenancePlan

getAllMaintenancePlanCycle

getMaintenancePlanCycleByKey

updateMaintenancePlanCycle

getAllMaintenancePlanSchedule

getMaintenancePlanScheduleByKey

getAllMaintenancePlanText

getMaintenancePlanTextByKey

updateMaintenancePlanText

getAllMaintItemObjectListItem

getMaintItemObjectListItemByKey

updateMaintItemObjectListItem

deleteMaintItemObjectListItem

getAllMaintenancePlanCallObject

getMaintenancePlanCallObjectByKey

getAllMaintPlanClfnCharValue

getMaintPlanClfnCharValueByKey

getAllMaintPlanClfnClass

getMaintPlanClfnClassByKey

getAllMaintPlanClfnClassChar

getMaintPlanClfnClassCharByKey

getAllMaintenancePlanStrategyCycle

getMaintenancePlanStrategyCycleByKey

assignMaintItemToMaintPlan

restartMaintPlnSchedule

startMaintPlnSchedule