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

Interface MaintenanceNotificationService

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

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..

Business Documentation

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 Details

  • Method Details

    • withServicePath

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

    • getAllMaintenanceNotification

      @Nonnull MaintenanceNotificationFluentHelper getAllMaintenanceNotification()
      Deprecated.
      Fetch multiple MaintenanceNotification entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceNotification 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.

    • getMaintenanceNotificationByKey

      @Nonnull MaintenanceNotificationByKeyFluentHelper getMaintenanceNotificationByKey(String maintenanceNotification)
      Deprecated.
      Fetch a single MaintenanceNotification entity using key fields.
      Parameters:
      maintenanceNotification - Notification Number

      Constraints: Not nullable, Maximum length: 12

      Returns:
      A fluent helper to fetch a single MaintenanceNotification 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.

    • createMaintenanceNotification

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

    • updateMaintenanceNotification

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

    • getAllMaintenanceNotificationItem

      @Nonnull MaintenanceNotificationItemFluentHelper getAllMaintenanceNotificationItem()
      Deprecated.
      Fetch multiple MaintenanceNotificationItem entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceNotificationItem 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.

    • getMaintenanceNotificationItemByKey

      @Nonnull MaintenanceNotificationItemByKeyFluentHelper getMaintenanceNotificationItemByKey(String maintenanceNotification, String maintenanceNotificationItem)
      Deprecated.
      Fetch a single MaintenanceNotificationItem entity using key fields.
      Parameters:
      maintenanceNotificationItem - Item Number in Item Record

      Constraints: Not nullable, Maximum length: 4

      maintenanceNotification - Notification Number

      Constraints: Not nullable, Maximum length: 12

      Returns:
      A fluent helper to fetch a single MaintenanceNotificationItem 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.

    • createMaintenanceNotificationItem

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

    • updateMaintenanceNotificationItem

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

    • getAllMaintenanceNotificationPartner

      @Nonnull MaintenanceNotificationPartnerFluentHelper getAllMaintenanceNotificationPartner()
      Deprecated.
      Fetch multiple MaintenanceNotificationPartner entities.
      Returns:
      A fluent helper to fetch multiple MaintenanceNotificationPartner 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.

    • getMaintenanceNotificationPartnerByKey

      @Nonnull MaintenanceNotificationPartnerByKeyFluentHelper getMaintenanceNotificationPartnerByKey(String maintenanceNotification, String partnerFunction, String notificationPartnerObjectNmbr)
      Deprecated.
      Fetch a single MaintenanceNotificationPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      maintenanceNotification - Notification Number

      Constraints: Not nullable, Maximum length: 12

      notificationPartnerObjectNmbr - Counter for differentiation 6-digit

      Constraints: Not nullable, Maximum length: 6

      Returns:
      A fluent helper to fetch a single MaintenanceNotificationPartner 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.

    • createMaintenanceNotificationPartner

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

    • updateMaintenanceNotificationPartner

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

    • getAllMaintNotificationItemActivity

      @Nonnull MaintNotificationItemActivityFluentHelper getAllMaintNotificationItemActivity()
      Deprecated.
      Fetch multiple MaintNotificationItemActivity entities.
      Returns:
      A fluent helper to fetch multiple MaintNotificationItemActivity 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.

    • getMaintNotificationItemActivityByKey

      @Nonnull MaintNotificationItemActivityByKeyFluentHelper getMaintNotificationItemActivityByKey(String maintNotificationActivity, String maintenanceNotification, String maintenanceNotificationItem)
      Deprecated.
      Fetch a single MaintNotificationItemActivity entity using key fields.
      Parameters:
      maintNotificationActivity - Consecutive Number of Activity

      Constraints: Not nullable, Maximum length: 4

      maintenanceNotificationItem - Item Number in Item Record

      Constraints: Not nullable, Maximum length: 4

      maintenanceNotification - Notification Number

      Constraints: Not nullable, Maximum length: 12

      Returns:
      A fluent helper to fetch a single MaintNotificationItemActivity 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.

    • createMaintNotificationItemActivity

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

    • updateMaintNotificationItemActivity

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

    • getAllMaintNotificationItemCause

      @Nonnull MaintNotificationItemCauseFluentHelper getAllMaintNotificationItemCause()
      Deprecated.
      Fetch multiple MaintNotificationItemCause entities.
      Returns:
      A fluent helper to fetch multiple MaintNotificationItemCause 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.

    • getMaintNotificationItemCauseByKey

      @Nonnull MaintNotificationItemCauseByKeyFluentHelper getMaintNotificationItemCauseByKey(String maintenanceNotification, String maintenanceNotificationItem, String maintenanceNotificationCause)
      Deprecated.
      Fetch a single MaintNotificationItemCause entity using key fields.
      Parameters:
      maintenanceNotificationItem - Item Number in Item Record

      Constraints: Not nullable, Maximum length: 4

      maintenanceNotificationCause - Sequential Number for Cause

      Constraints: Not nullable, Maximum length: 4

      maintenanceNotification - Notification Number

      Constraints: Not nullable, Maximum length: 12

      Returns:
      A fluent helper to fetch a single MaintNotificationItemCause 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.

    • createMaintNotificationItemCause

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

    • updateMaintNotificationItemCause

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

    • completeMaintNotification

      @Nonnull CompleteMaintNotificationFluentHelper completeMaintNotification(@Nonnull String maintenanceNotification, @Nullable LocalDateTime notificationReferenceDate, @Nullable LocalTime notificationReferenceTime)
      Deprecated.

      Creates a fluent helper for the CompleteMaintNotification OData function import.

      Parameters:
      notificationReferenceDate - Reference Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: NotificationReferenceDate

      maintenanceNotification - Notification

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: MaintenanceNotification

      notificationReferenceTime - Reference Time

      Constraints: 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 execute method on the fluent helper object.

    • completeMaintNotification

      @Nonnull CompleteMaintNotificationFluentHelper completeMaintNotification(@Nonnull String maintenanceNotification, @Nullable LocalDateTime notificationReferenceDate, @Nullable LocalTime notificationReferenceTime, @Nullable ZonedDateTime maintNotifReferenceDateTime)
      Deprecated.

      Creates a fluent helper for the CompleteMaintNotification OData function import.

      Parameters:
      notificationReferenceDate - Reference Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: NotificationReferenceDate

      maintenanceNotification - Notification

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: MaintenanceNotification

      notificationReferenceTime - Reference Time

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: NotificationReferenceTime

      maintNotifReferenceDateTime - Reference Date Time

      Constraints: 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 execute method on the fluent helper object.

    • setMaintNotifToInProcess

      @Nonnull SetMaintNotifToInProcessFluentHelper setMaintNotifToInProcess(@Nonnull String maintenanceNotification)
      Deprecated.

      Creates a fluent helper for the SetMaintNotifToInProcess OData function import.

      Parameters:
      maintenanceNotification - Notification

      Constraints: 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 execute method on the fluent helper object.