Interface JointOperatingAgreementService

All Known Implementing Classes:
DefaultJointOperatingAgreementService

@Deprecated public interface JointOperatingAgreementService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains Joint Operating Agreement, Description, Equity Group, Penalty Category Recovery Percentage and Partner Share nodes. The information is sent in the request as a payload, which is used in creating or updating a Joint Operating Agreement, including appropriate checks for restricted values and authorizations. If there are any issues when the Joint Operating Agreement is created, updated or deleted, the system displays error messages in the response.

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_JNTOPGAGRMT_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Joint Venture Accounting API Integration(SAP_COM_0383)
Scope Items: Joint Venture Accounting(3F7)
Authentication Methods: x509
Service Group Name: API_JNTOPGAGRMT
Business Object: Joint Operating Agreement
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull JointOperatingAgreementService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.
    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
    • getAllJntOpgAgrmt

      @Nonnull GetAllRequestBuilder<JntOpgAgrmt> getAllJntOpgAgrmt()
      Deprecated.
      Fetch multiple JntOpgAgrmt entities.
      Returns:
      A request builder to fetch multiple JntOpgAgrmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countJntOpgAgrmt

      @Nonnull CountRequestBuilder<JntOpgAgrmt> countJntOpgAgrmt()
      Deprecated.
      Fetch the number of entries from the JntOpgAgrmt entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of JntOpgAgrmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getJntOpgAgrmtByKey

      @Nonnull GetByKeyRequestBuilder<JntOpgAgrmt> getJntOpgAgrmtByKey(String companyCode, String jntOpgAgrmt)
      Deprecated.
      Fetch a single JntOpgAgrmt entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      jntOpgAgrmt - Joint Operating Agreement

      Constraints: Not nullable, Maximum length: 6

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

      @Nonnull CreateRequestBuilder<JntOpgAgrmt> createJntOpgAgrmt(@Nonnull JntOpgAgrmt jntOpgAgrmt)
      Deprecated.
      Create a new JntOpgAgrmt entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmt - JntOpgAgrmt entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new JntOpgAgrmt entity. To perform execution, call the execute method on the request builder object.
    • updateJntOpgAgrmt

      @Nonnull UpdateRequestBuilder<JntOpgAgrmt> updateJntOpgAgrmt(@Nonnull JntOpgAgrmt jntOpgAgrmt)
      Deprecated.
      Update an existing JntOpgAgrmt entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmt - JntOpgAgrmt entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing JntOpgAgrmt entity. To perform execution, call the execute method on the request builder object.
    • deleteJntOpgAgrmt

      @Nonnull DeleteRequestBuilder<JntOpgAgrmt> deleteJntOpgAgrmt(@Nonnull JntOpgAgrmt jntOpgAgrmt)
      Deprecated.
      Deletes an existing JntOpgAgrmt entity in the S/4HANA system.
      Parameters:
      jntOpgAgrmt - JntOpgAgrmt entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing JntOpgAgrmt entity. To perform execution, call the execute method on the request builder object.
    • getAllJntOpgAgrmtEquityTypeGrp

      @Nonnull GetAllRequestBuilder<JntOpgAgrmtEquityTypeGrp> getAllJntOpgAgrmtEquityTypeGrp()
      Deprecated.
      Fetch multiple JntOpgAgrmtEquityTypeGrp entities.
      Returns:
      A request builder to fetch multiple JntOpgAgrmtEquityTypeGrp entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countJntOpgAgrmtEquityTypeGrp

      @Nonnull CountRequestBuilder<JntOpgAgrmtEquityTypeGrp> countJntOpgAgrmtEquityTypeGrp()
      Deprecated.
      Fetch the number of entries from the JntOpgAgrmtEquityTypeGrp entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of JntOpgAgrmtEquityTypeGrp entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getJntOpgAgrmtEquityTypeGrpByKey

      @Nonnull GetByKeyRequestBuilder<JntOpgAgrmtEquityTypeGrp> getJntOpgAgrmtEquityTypeGrpByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp)
      Deprecated.
      Fetch a single JntOpgAgrmtEquityTypeGrp entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      jntOpgAgrmtEquityGrp - Equity Group - JOA level

      Constraints: Not nullable, Maximum length: 3

      jntOpgAgrmt - Joint Operating Agreement

      Constraints: Not nullable, Maximum length: 6

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

      @Nonnull CreateRequestBuilder<JntOpgAgrmtEquityTypeGrp> createJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp)
      Deprecated.
      Create a new JntOpgAgrmtEquityTypeGrp entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmtEquityTypeGrp - JntOpgAgrmtEquityTypeGrp entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new JntOpgAgrmtEquityTypeGrp entity. To perform execution, call the execute method on the request builder object.
    • updateJntOpgAgrmtEquityTypeGrp

      @Nonnull UpdateRequestBuilder<JntOpgAgrmtEquityTypeGrp> updateJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp)
      Deprecated.
      Update an existing JntOpgAgrmtEquityTypeGrp entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmtEquityTypeGrp - JntOpgAgrmtEquityTypeGrp entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing JntOpgAgrmtEquityTypeGrp entity. To perform execution, call the execute method on the request builder object.
    • deleteJntOpgAgrmtEquityTypeGrp

      @Nonnull DeleteRequestBuilder<JntOpgAgrmtEquityTypeGrp> deleteJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp)
      Deprecated.
      Deletes an existing JntOpgAgrmtEquityTypeGrp entity in the S/4HANA system.
      Parameters:
      jntOpgAgrmtEquityTypeGrp - JntOpgAgrmtEquityTypeGrp entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing JntOpgAgrmtEquityTypeGrp entity. To perform execution, call the execute method on the request builder object.
    • getAllJntOpgAgrmtPartShr

      @Nonnull GetAllRequestBuilder<JntOpgAgrmtPartShr> getAllJntOpgAgrmtPartShr()
      Deprecated.
      Fetch multiple JntOpgAgrmtPartShr entities.
      Returns:
      A request builder to fetch multiple JntOpgAgrmtPartShr entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countJntOpgAgrmtPartShr

      @Nonnull CountRequestBuilder<JntOpgAgrmtPartShr> countJntOpgAgrmtPartShr()
      Deprecated.
      Fetch the number of entries from the JntOpgAgrmtPartShr entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of JntOpgAgrmtPartShr entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getJntOpgAgrmtPartShrByKey

      @Nonnull GetByKeyRequestBuilder<JntOpgAgrmtPartShr> getJntOpgAgrmtPartShrByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp, String jointVenturePartner)
      Deprecated.
      Fetch a single JntOpgAgrmtPartShr entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      jntOpgAgrmtEquityGrp - Equity Group - JOA level

      Constraints: Not nullable, Maximum length: 3

      jntOpgAgrmt - Joint Operating Agreement

      Constraints: Not nullable, Maximum length: 6

      jointVenturePartner - JV Partner

      Constraints: Not nullable, Maximum length: 10

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

      @Nonnull UpdateRequestBuilder<JntOpgAgrmtPartShr> updateJntOpgAgrmtPartShr(@Nonnull JntOpgAgrmtPartShr jntOpgAgrmtPartShr)
      Deprecated.
      Update an existing JntOpgAgrmtPartShr entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmtPartShr - JntOpgAgrmtPartShr entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing JntOpgAgrmtPartShr entity. To perform execution, call the execute method on the request builder object.
    • deleteJntOpgAgrmtPartShr

      @Nonnull DeleteRequestBuilder<JntOpgAgrmtPartShr> deleteJntOpgAgrmtPartShr(@Nonnull JntOpgAgrmtPartShr jntOpgAgrmtPartShr)
      Deprecated.
      Deletes an existing JntOpgAgrmtPartShr entity in the S/4HANA system.
      Parameters:
      jntOpgAgrmtPartShr - JntOpgAgrmtPartShr entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing JntOpgAgrmtPartShr entity. To perform execution, call the execute method on the request builder object.
    • getAllJntOpgAgrmtPnltyCatRcvry

      @Nonnull GetAllRequestBuilder<JntOpgAgrmtPnltyCatRcvry> getAllJntOpgAgrmtPnltyCatRcvry()
      Deprecated.
      Fetch multiple JntOpgAgrmtPnltyCatRcvry entities.
      Returns:
      A request builder to fetch multiple JntOpgAgrmtPnltyCatRcvry entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countJntOpgAgrmtPnltyCatRcvry

      @Nonnull CountRequestBuilder<JntOpgAgrmtPnltyCatRcvry> countJntOpgAgrmtPnltyCatRcvry()
      Deprecated.
      Fetch the number of entries from the JntOpgAgrmtPnltyCatRcvry entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of JntOpgAgrmtPnltyCatRcvry entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getJntOpgAgrmtPnltyCatRcvryByKey

      @Nonnull GetByKeyRequestBuilder<JntOpgAgrmtPnltyCatRcvry> getJntOpgAgrmtPnltyCatRcvryByKey(String companyCode, String jntOpgAgrmt, String jntVntrPenaltyCategory)
      Deprecated.
      Fetch a single JntOpgAgrmtPnltyCatRcvry entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      jntOpgAgrmt - Joint Operating Agreement

      Constraints: Not nullable, Maximum length: 6

      jntVntrPenaltyCategory - Penalty Category

      Constraints: Not nullable, Maximum length: 1

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

      @Nonnull UpdateRequestBuilder<JntOpgAgrmtPnltyCatRcvry> updateJntOpgAgrmtPnltyCatRcvry(@Nonnull JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry)
      Deprecated.
      Update an existing JntOpgAgrmtPnltyCatRcvry entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmtPnltyCatRcvry - JntOpgAgrmtPnltyCatRcvry entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing JntOpgAgrmtPnltyCatRcvry entity. To perform execution, call the execute method on the request builder object.
    • deleteJntOpgAgrmtPnltyCatRcvry

      @Nonnull DeleteRequestBuilder<JntOpgAgrmtPnltyCatRcvry> deleteJntOpgAgrmtPnltyCatRcvry(@Nonnull JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry)
      Deprecated.
      Deletes an existing JntOpgAgrmtPnltyCatRcvry entity in the S/4HANA system.
      Parameters:
      jntOpgAgrmtPnltyCatRcvry - JntOpgAgrmtPnltyCatRcvry entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing JntOpgAgrmtPnltyCatRcvry entity. To perform execution, call the execute method on the request builder object.
    • getAllJntOpgAgrmtText

      @Nonnull GetAllRequestBuilder<JntOpgAgrmtText> getAllJntOpgAgrmtText()
      Deprecated.
      Fetch multiple JntOpgAgrmtText entities.
      Returns:
      A request builder to fetch multiple JntOpgAgrmtText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countJntOpgAgrmtText

      @Nonnull CountRequestBuilder<JntOpgAgrmtText> countJntOpgAgrmtText()
      Deprecated.
      Fetch the number of entries from the JntOpgAgrmtText entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of JntOpgAgrmtText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getJntOpgAgrmtTextByKey

      @Nonnull GetByKeyRequestBuilder<JntOpgAgrmtText> getJntOpgAgrmtTextByKey(String companyCode, String language, String jntOpgAgrmt)
      Deprecated.
      Fetch a single JntOpgAgrmtText entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      jntOpgAgrmt - Joint Operating Agreement

      Constraints: Not nullable, Maximum length: 6

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

      @Nonnull UpdateRequestBuilder<JntOpgAgrmtText> updateJntOpgAgrmtText(@Nonnull JntOpgAgrmtText jntOpgAgrmtText)
      Deprecated.
      Update an existing JntOpgAgrmtText entity and save it to the S/4HANA system.
      Parameters:
      jntOpgAgrmtText - JntOpgAgrmtText entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing JntOpgAgrmtText entity. To perform execution, call the execute method on the request builder object.
    • deleteJntOpgAgrmtText

      @Nonnull DeleteRequestBuilder<JntOpgAgrmtText> deleteJntOpgAgrmtText(@Nonnull JntOpgAgrmtText jntOpgAgrmtText)
      Deprecated.
      Deletes an existing JntOpgAgrmtText entity in the S/4HANA system.
      Parameters:
      jntOpgAgrmtText - JntOpgAgrmtText entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing JntOpgAgrmtText entity. To perform execution, call the execute method on the request builder object.