Class DefaultMaintenanceNotificationService
- All Implemented Interfaces:
BatchService<MaintenanceNotificationServiceBatch>,MaintenanceNotificationService
This service contains maintenance notification header details, item, item cause, item activity, and partner function. The information is sent in the request as a payload. The request payload contains all information required to create or update a maintenance notification. All the information in the payload is used to create or update a maintenance notification including appropriate checks for restricted values and authorizations. Once the maintenance notification has been created, the notification number is sent in the response with the data included. If the input in the request is not as expected when you create or update a maintenance notification, the system displays appropriate error or warning messages in the response..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_MAINTNOTIFICATION |
| API Version: | 1.3.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 |
| Business Object: | Maintenance Notification |
-
Field Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.MaintenanceNotificationService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingMaintenanceNotificationService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.completeMaintNotification(String maintenanceNotification, LocalDateTime notificationReferenceDate, LocalTime notificationReferenceTime) Deprecated.Creates a fluent helper for the CompleteMaintNotification OData function import.completeMaintNotification(String maintenanceNotification, LocalDateTime notificationReferenceDate, LocalTime notificationReferenceTime, ZonedDateTime maintNotifReferenceDateTime) Deprecated.Creates a fluent helper for the CompleteMaintNotification OData function import.createMaintenanceNotification(MaintenanceNotification maintenanceNotification) Deprecated.Create a newMaintenanceNotificationentity and save it to the S/4HANA system.createMaintenanceNotificationItem(MaintenanceNotificationItem maintenanceNotificationItem) Deprecated.Create a newMaintenanceNotificationItementity and save it to the S/4HANA system.createMaintenanceNotificationPartner(MaintenanceNotificationPartner maintenanceNotificationPartner) Deprecated.Create a newMaintenanceNotificationPartnerentity and save it to the S/4HANA system.createMaintNotificationItemActivity(MaintNotificationItemActivity maintNotificationItemActivity) Deprecated.Create a newMaintNotificationItemActivityentity and save it to the S/4HANA system.createMaintNotificationItemCause(MaintNotificationItemCause maintNotificationItemCause) Deprecated.Create a newMaintNotificationItemCauseentity and save it to the S/4HANA system.Deprecated.Fetch multipleMaintenanceNotificationentities.Deprecated.Fetch multipleMaintenanceNotificationItementities.Deprecated.Fetch multipleMaintenanceNotificationPartnerentities.Deprecated.Fetch multipleMaintNotificationItemActivityentities.Deprecated.Fetch multipleMaintNotificationItemCauseentities.getMaintenanceNotificationByKey(String maintenanceNotification) Deprecated.Fetch a singleMaintenanceNotificationentity using key fields.getMaintenanceNotificationItemByKey(String maintenanceNotification, String maintenanceNotificationItem) Deprecated.Fetch a singleMaintenanceNotificationItementity using key fields.getMaintenanceNotificationPartnerByKey(String maintenanceNotification, String partnerFunction, String notificationPartnerObjectNmbr) Deprecated.Fetch a singleMaintenanceNotificationPartnerentity using key fields.getMaintNotificationItemActivityByKey(String maintNotificationActivity, String maintenanceNotification, String maintenanceNotificationItem) Deprecated.Fetch a singleMaintNotificationItemActivityentity using key fields.getMaintNotificationItemCauseByKey(String maintenanceNotification, String maintenanceNotificationItem, String maintenanceNotificationCause) Deprecated.Fetch a singleMaintNotificationItemCauseentity using key fields.setMaintNotifToInProcess(String maintenanceNotification) Deprecated.Creates a fluent helper for the SetMaintNotifToInProcess OData function import.updateMaintenanceNotification(MaintenanceNotification maintenanceNotification) Deprecated.Update an existingMaintenanceNotificationentity and save it to the S/4HANA system.updateMaintenanceNotificationItem(MaintenanceNotificationItem maintenanceNotificationItem) Deprecated.Update an existingMaintenanceNotificationItementity and save it to the S/4HANA system.updateMaintenanceNotificationPartner(MaintenanceNotificationPartner maintenanceNotificationPartner) Deprecated.Update an existingMaintenanceNotificationPartnerentity and save it to the S/4HANA system.updateMaintNotificationItemActivity(MaintNotificationItemActivity maintNotificationItemActivity) Deprecated.Update an existingMaintNotificationItemActivityentity and save it to the S/4HANA system.updateMaintNotificationItemCause(MaintNotificationItemCause maintNotificationItemCause) Deprecated.Update an existingMaintNotificationItemCauseentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Constructor Details
-
DefaultMaintenanceNotificationService
public DefaultMaintenanceNotificationService()Deprecated.Creates a service usingMaintenanceNotificationService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
Deprecated.Description copied from interface:MaintenanceNotificationServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfaceMaintenanceNotificationService- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.- Specified by:
batchin interfaceBatchService<MaintenanceNotificationServiceBatch>
-
getAllMaintenanceNotification
Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch multipleMaintenanceNotificationentities.- Specified by:
getAllMaintenanceNotificationin interfaceMaintenanceNotificationService- Returns:
- A fluent helper to fetch multiple
MaintenanceNotificationentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getMaintenanceNotificationByKey
@Nonnull public MaintenanceNotificationByKeyFluentHelper getMaintenanceNotificationByKey(String maintenanceNotification) Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch a singleMaintenanceNotificationentity using key fields.- Specified by:
getMaintenanceNotificationByKeyin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- Notification NumberConstraints: Not nullable, Maximum length: 12
- Returns:
- A fluent helper to fetch a single
MaintenanceNotificationentity 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 theexecutemethod on the fluent helper object.
-
createMaintenanceNotification
@Nonnull public MaintenanceNotificationCreateFluentHelper createMaintenanceNotification(@Nonnull MaintenanceNotification maintenanceNotification) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreate a newMaintenanceNotificationentity and save it to the S/4HANA system.- Specified by:
createMaintenanceNotificationin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification-MaintenanceNotificationentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
MaintenanceNotificationentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateMaintenanceNotification
@Nonnull public MaintenanceNotificationUpdateFluentHelper updateMaintenanceNotification(@Nonnull MaintenanceNotification maintenanceNotification) Deprecated.Description copied from interface:MaintenanceNotificationServiceUpdate an existingMaintenanceNotificationentity and save it to the S/4HANA system.- Specified by:
updateMaintenanceNotificationin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification-MaintenanceNotificationentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
MaintenanceNotificationentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllMaintenanceNotificationItem
Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch multipleMaintenanceNotificationItementities.- Specified by:
getAllMaintenanceNotificationItemin interfaceMaintenanceNotificationService- Returns:
- A fluent helper to fetch multiple
MaintenanceNotificationItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getMaintenanceNotificationItemByKey
@Nonnull public MaintenanceNotificationItemByKeyFluentHelper getMaintenanceNotificationItemByKey(String maintenanceNotification, String maintenanceNotificationItem) Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch a singleMaintenanceNotificationItementity using key fields.- Specified by:
getMaintenanceNotificationItemByKeyin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- Notification NumberConstraints: Not nullable, Maximum length: 12
maintenanceNotificationItem- Item Number in Item RecordConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
MaintenanceNotificationItementity 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 theexecutemethod on the fluent helper object.
-
createMaintenanceNotificationItem
@Nonnull public MaintenanceNotificationItemCreateFluentHelper createMaintenanceNotificationItem(@Nonnull MaintenanceNotificationItem maintenanceNotificationItem) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreate a newMaintenanceNotificationItementity and save it to the S/4HANA system.- Specified by:
createMaintenanceNotificationItemin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotificationItem-MaintenanceNotificationItementity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
MaintenanceNotificationItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateMaintenanceNotificationItem
@Nonnull public MaintenanceNotificationItemUpdateFluentHelper updateMaintenanceNotificationItem(@Nonnull MaintenanceNotificationItem maintenanceNotificationItem) Deprecated.Description copied from interface:MaintenanceNotificationServiceUpdate an existingMaintenanceNotificationItementity and save it to the S/4HANA system.- Specified by:
updateMaintenanceNotificationItemin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotificationItem-MaintenanceNotificationItementity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
MaintenanceNotificationItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllMaintenanceNotificationPartner
Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch multipleMaintenanceNotificationPartnerentities.- Specified by:
getAllMaintenanceNotificationPartnerin interfaceMaintenanceNotificationService- Returns:
- A fluent helper to fetch multiple
MaintenanceNotificationPartnerentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getMaintenanceNotificationPartnerByKey
@Nonnull public MaintenanceNotificationPartnerByKeyFluentHelper getMaintenanceNotificationPartnerByKey(String maintenanceNotification, String partnerFunction, String notificationPartnerObjectNmbr) Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch a singleMaintenanceNotificationPartnerentity using key fields.- Specified by:
getMaintenanceNotificationPartnerByKeyin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- Notification NumberConstraints: Not nullable, Maximum length: 12
partnerFunction- Partner FunctionConstraints: Not nullable, Maximum length: 2
notificationPartnerObjectNmbr- Counter for differentiation 6-digitConstraints: Not nullable, Maximum length: 6
- Returns:
- A fluent helper to fetch a single
MaintenanceNotificationPartnerentity 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 theexecutemethod on the fluent helper object.
-
createMaintenanceNotificationPartner
@Nonnull public MaintenanceNotificationPartnerCreateFluentHelper createMaintenanceNotificationPartner(@Nonnull MaintenanceNotificationPartner maintenanceNotificationPartner) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreate a newMaintenanceNotificationPartnerentity and save it to the S/4HANA system.- Specified by:
createMaintenanceNotificationPartnerin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotificationPartner-MaintenanceNotificationPartnerentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
MaintenanceNotificationPartnerentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateMaintenanceNotificationPartner
@Nonnull public MaintenanceNotificationPartnerUpdateFluentHelper updateMaintenanceNotificationPartner(@Nonnull MaintenanceNotificationPartner maintenanceNotificationPartner) Deprecated.Description copied from interface:MaintenanceNotificationServiceUpdate an existingMaintenanceNotificationPartnerentity and save it to the S/4HANA system.- Specified by:
updateMaintenanceNotificationPartnerin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotificationPartner-MaintenanceNotificationPartnerentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
MaintenanceNotificationPartnerentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllMaintNotificationItemActivity
Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch multipleMaintNotificationItemActivityentities.- Specified by:
getAllMaintNotificationItemActivityin interfaceMaintenanceNotificationService- Returns:
- A fluent helper to fetch multiple
MaintNotificationItemActivityentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getMaintNotificationItemActivityByKey
@Nonnull public MaintNotificationItemActivityByKeyFluentHelper getMaintNotificationItemActivityByKey(String maintNotificationActivity, String maintenanceNotification, String maintenanceNotificationItem) Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch a singleMaintNotificationItemActivityentity using key fields.- Specified by:
getMaintNotificationItemActivityByKeyin interfaceMaintenanceNotificationService- Parameters:
maintNotificationActivity- Consecutive Number of ActivityConstraints: Not nullable, Maximum length: 4
maintenanceNotification- Notification NumberConstraints: Not nullable, Maximum length: 12
maintenanceNotificationItem- Item Number in Item RecordConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
MaintNotificationItemActivityentity 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 theexecutemethod on the fluent helper object.
-
createMaintNotificationItemActivity
@Nonnull public MaintNotificationItemActivityCreateFluentHelper createMaintNotificationItemActivity(@Nonnull MaintNotificationItemActivity maintNotificationItemActivity) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreate a newMaintNotificationItemActivityentity and save it to the S/4HANA system.- Specified by:
createMaintNotificationItemActivityin interfaceMaintenanceNotificationService- Parameters:
maintNotificationItemActivity-MaintNotificationItemActivityentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
MaintNotificationItemActivityentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateMaintNotificationItemActivity
@Nonnull public MaintNotificationItemActivityUpdateFluentHelper updateMaintNotificationItemActivity(@Nonnull MaintNotificationItemActivity maintNotificationItemActivity) Deprecated.Description copied from interface:MaintenanceNotificationServiceUpdate an existingMaintNotificationItemActivityentity and save it to the S/4HANA system.- Specified by:
updateMaintNotificationItemActivityin interfaceMaintenanceNotificationService- Parameters:
maintNotificationItemActivity-MaintNotificationItemActivityentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
MaintNotificationItemActivityentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllMaintNotificationItemCause
Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch multipleMaintNotificationItemCauseentities.- Specified by:
getAllMaintNotificationItemCausein interfaceMaintenanceNotificationService- Returns:
- A fluent helper to fetch multiple
MaintNotificationItemCauseentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getMaintNotificationItemCauseByKey
@Nonnull public MaintNotificationItemCauseByKeyFluentHelper getMaintNotificationItemCauseByKey(String maintenanceNotification, String maintenanceNotificationItem, String maintenanceNotificationCause) Deprecated.Description copied from interface:MaintenanceNotificationServiceFetch a singleMaintNotificationItemCauseentity using key fields.- Specified by:
getMaintNotificationItemCauseByKeyin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- Notification NumberConstraints: Not nullable, Maximum length: 12
maintenanceNotificationItem- Item Number in Item RecordConstraints: Not nullable, Maximum length: 4
maintenanceNotificationCause- Sequential Number for CauseConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
MaintNotificationItemCauseentity 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 theexecutemethod on the fluent helper object.
-
createMaintNotificationItemCause
@Nonnull public MaintNotificationItemCauseCreateFluentHelper createMaintNotificationItemCause(@Nonnull MaintNotificationItemCause maintNotificationItemCause) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreate a newMaintNotificationItemCauseentity and save it to the S/4HANA system.- Specified by:
createMaintNotificationItemCausein interfaceMaintenanceNotificationService- Parameters:
maintNotificationItemCause-MaintNotificationItemCauseentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
MaintNotificationItemCauseentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateMaintNotificationItemCause
@Nonnull public MaintNotificationItemCauseUpdateFluentHelper updateMaintNotificationItemCause(@Nonnull MaintNotificationItemCause maintNotificationItemCause) Deprecated.Description copied from interface:MaintenanceNotificationServiceUpdate an existingMaintNotificationItemCauseentity and save it to the S/4HANA system.- Specified by:
updateMaintNotificationItemCausein interfaceMaintenanceNotificationService- Parameters:
maintNotificationItemCause-MaintNotificationItemCauseentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
MaintNotificationItemCauseentity. To perform execution, call theexecutemethod on the fluent helper object.
-
completeMaintNotification
@Nonnull public CompleteMaintNotificationFluentHelper completeMaintNotification(@Nonnull String maintenanceNotification, @Nullable LocalDateTime notificationReferenceDate, @Nullable LocalTime notificationReferenceTime) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreates a fluent helper for the CompleteMaintNotification OData function import.
- Specified by:
completeMaintNotificationin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- NotificationConstraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: MaintenanceNotification
notificationReferenceDate- Reference DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: NotificationReferenceDate
notificationReferenceTime- Reference TimeConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: NotificationReferenceTime
- Returns:
- A fluent helper object that will execute the CompleteMaintNotification OData function import with
the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
completeMaintNotification
@Nonnull public CompleteMaintNotificationFluentHelper completeMaintNotification(@Nonnull String maintenanceNotification, @Nullable LocalDateTime notificationReferenceDate, @Nullable LocalTime notificationReferenceTime, @Nullable ZonedDateTime maintNotifReferenceDateTime) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreates a fluent helper for the CompleteMaintNotification OData function import.
- Specified by:
completeMaintNotificationin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- NotificationConstraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: MaintenanceNotification
notificationReferenceDate- Reference DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: NotificationReferenceDate
notificationReferenceTime- Reference TimeConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: NotificationReferenceTime
maintNotifReferenceDateTime- Reference Date TimeConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: MaintNotifReferenceDateTime
- Returns:
- A fluent helper object that will execute the CompleteMaintNotification OData function import with
the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
setMaintNotifToInProcess
@Nonnull public SetMaintNotifToInProcessFluentHelper setMaintNotifToInProcess(@Nonnull String maintenanceNotification) Deprecated.Description copied from interface:MaintenanceNotificationServiceCreates a fluent helper for the SetMaintNotifToInProcess OData function import.
- Specified by:
setMaintNotifToInProcessin interfaceMaintenanceNotificationService- Parameters:
maintenanceNotification- NotificationConstraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: MaintenanceNotification
- Returns:
- A fluent helper object that will execute the SetMaintNotifToInProcess OData function import with
the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-