com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface JointVentureService

All Known Implementing Classes:

DefaultJointVentureService

public interface JointVentureService

The service contains Joint Venture, Description, Equity Group, Equity Type, and Equity Share nodes. The information is sent in the request as a payload, which is used in creating or updating a joint venture, including appropriate checks for restricted values and authorizations. If there are any issues when the joint venture is created or updated, the system displays error messages in the response. The service does not allow deletion of any of joint ventures, descriptions, equity group, equity type or equity share.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_JOINTVENTURE_0001
API Version:	1
Communication Scenario:	Joint Venture Accounting API Integration (SAP_COM_0383)
Scope Items:	Joint Venture Accounting (3F7)
Authentication Methods:	Basic, x509
Service Group Name:	API_JOINTVENTURE

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

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<JntVntrPartEquityShr>	countJntVntrPartEquityShr() Fetch the number of entries from the JntVntrPartEquityShr entity collection matching the filter and search expressions.
CountRequestBuilder<JointVenture>	countJointVenture() Fetch the number of entries from the JointVenture entity collection matching the filter and search expressions.
CountRequestBuilder<JointVentureDescription>	countJointVentureDescription() Fetch the number of entries from the JointVentureDescription entity collection matching the filter and search expressions.
CountRequestBuilder<JointVentureEquityGroup>	countJointVentureEquityGroup() Fetch the number of entries from the JointVentureEquityGroup entity collection matching the filter and search expressions.
CountRequestBuilder<JointVentureEquityType>	countJointVentureEquityType() Fetch the number of entries from the JointVentureEquityType entity collection matching the filter and search expressions.
CreateRequestBuilder<JntVntrPartEquityShr>	createJntVntrPartEquityShr(JntVntrPartEquityShr jntVntrPartEquityShr) Create a new JntVntrPartEquityShr entity and save it to the S/4HANA system.
CreateRequestBuilder<JointVenture>	createJointVenture(JointVenture jointVenture) Create a new JointVenture entity and save it to the S/4HANA system.
CreateRequestBuilder<JointVentureDescription>	createJointVentureDescription(JointVentureDescription jointVentureDescription) Create a new JointVentureDescription entity and save it to the S/4HANA system.
CreateRequestBuilder<JointVentureEquityGroup>	createJointVentureEquityGroup(JointVentureEquityGroup jointVentureEquityGroup) Create a new JointVentureEquityGroup entity and save it to the S/4HANA system.
CreateRequestBuilder<JointVentureEquityType>	createJointVentureEquityType(JointVentureEquityType jointVentureEquityType) Create a new JointVentureEquityType entity and save it to the S/4HANA system.
GetAllRequestBuilder<JntVntrPartEquityShr>	getAllJntVntrPartEquityShr() Fetch multiple JntVntrPartEquityShr entities.
GetAllRequestBuilder<JointVenture>	getAllJointVenture() Fetch multiple JointVenture entities.
GetAllRequestBuilder<JointVentureDescription>	getAllJointVentureDescription() Fetch multiple JointVentureDescription entities.
GetAllRequestBuilder<JointVentureEquityGroup>	getAllJointVentureEquityGroup() Fetch multiple JointVentureEquityGroup entities.
GetAllRequestBuilder<JointVentureEquityType>	getAllJointVentureEquityType() Fetch multiple JointVentureEquityType entities.
GetByKeyRequestBuilder<JntVntrPartEquityShr>	getJntVntrPartEquityShrByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp, String jointVenturePartner) Fetch a single JntVntrPartEquityShr entity using key fields.
GetByKeyRequestBuilder<JointVenture>	getJointVentureByKey(String companyCode, String jointVenture) Fetch a single JointVenture entity using key fields.
GetByKeyRequestBuilder<JointVentureDescription>	getJointVentureDescriptionByKey(String companyCode, String language, String jointVenture) Fetch a single JointVentureDescription entity using key fields.
GetByKeyRequestBuilder<JointVentureEquityGroup>	getJointVentureEquityGroupByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp) Fetch a single JointVentureEquityGroup entity using key fields.
GetByKeyRequestBuilder<JointVentureEquityType>	getJointVentureEquityTypeByKey(String companyCode, String jointVenture, String jointVentureEquityType, String jointVentureEquityFundingDate) Fetch a single JointVentureEquityType entity using key fields.
UpdateRequestBuilder<JntVntrPartEquityShr>	updateJntVntrPartEquityShr(JntVntrPartEquityShr jntVntrPartEquityShr) Update an existing JntVntrPartEquityShr entity and save it to the S/4HANA system.
UpdateRequestBuilder<JointVenture>	updateJointVenture(JointVenture jointVenture) Update an existing JointVenture entity and save it to the S/4HANA system.
UpdateRequestBuilder<JointVentureDescription>	updateJointVentureDescription(JointVentureDescription jointVentureDescription) Update an existing JointVentureDescription entity and save it to the S/4HANA system.
UpdateRequestBuilder<JointVentureEquityGroup>	updateJointVentureEquityGroup(JointVentureEquityGroup jointVentureEquityGroup) Update an existing JointVentureEquityGroup entity and save it to the S/4HANA system.
UpdateRequestBuilder<JointVentureEquityType>	updateJointVentureEquityType(JointVentureEquityType jointVentureEquityType) Update an existing JointVentureEquityType entity and save it to the S/4HANA system.
JointVentureService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

batch

@Nonnull
BatchRequestBuilder batch()

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.

getAllJntVntrPartEquityShr

@Nonnull
GetAllRequestBuilder<JntVntrPartEquityShr> getAllJntVntrPartEquityShr()

Fetch multiple JntVntrPartEquityShr entities.

Returns:

A request builder to fetch multiple JntVntrPartEquityShr 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.

countJntVntrPartEquityShr

@Nonnull
CountRequestBuilder<JntVntrPartEquityShr> countJntVntrPartEquityShr()

Fetch the number of entries from the JntVntrPartEquityShr entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of JntVntrPartEquityShr 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.

getJntVntrPartEquityShrByKey

@Nonnull
GetByKeyRequestBuilder<JntVntrPartEquityShr> getJntVntrPartEquityShrByKey(@Nonnull
                                                                                   String companyCode,
                                                                                   @Nonnull
                                                                                   String jointVenture,
                                                                                   @Nonnull
                                                                                   String jntOpgAgrmtEquityGrp,
                                                                                   @Nonnull
                                                                                   String jointVenturePartner)

Fetch a single JntVntrPartEquityShr entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

jointVenture - Joint Venture

Constraints: Not nullable, Maximum length: 6

jntOpgAgrmtEquityGrp - Equity Group

Constraints: Not nullable, Maximum length: 3

jointVenturePartner - JV partner

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single JntVntrPartEquityShr 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.

createJntVntrPartEquityShr

@Nonnull
CreateRequestBuilder<JntVntrPartEquityShr> createJntVntrPartEquityShr(@Nonnull
                                                                               JntVntrPartEquityShr jntVntrPartEquityShr)

Create a new JntVntrPartEquityShr entity and save it to the S/4HANA system.

Parameters:

jntVntrPartEquityShr - JntVntrPartEquityShr entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new JntVntrPartEquityShr entity. To perform execution, call the execute method on the request builder object.

updateJntVntrPartEquityShr

@Nonnull
UpdateRequestBuilder<JntVntrPartEquityShr> updateJntVntrPartEquityShr(@Nonnull
                                                                               JntVntrPartEquityShr jntVntrPartEquityShr)

Update an existing JntVntrPartEquityShr entity and save it to the S/4HANA system.

Parameters:

jntVntrPartEquityShr - JntVntrPartEquityShr entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing JntVntrPartEquityShr entity. To perform execution, call the execute method on the request builder object.

getAllJointVenture

@Nonnull
GetAllRequestBuilder<JointVenture> getAllJointVenture()

Fetch multiple JointVenture entities.

Returns:

A request builder to fetch multiple JointVenture 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.

countJointVenture

@Nonnull
CountRequestBuilder<JointVenture> countJointVenture()

Fetch the number of entries from the JointVenture entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of JointVenture 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.

getJointVentureByKey

@Nonnull
GetByKeyRequestBuilder<JointVenture> getJointVentureByKey(@Nonnull
                                                                   String companyCode,
                                                                   @Nonnull
                                                                   String jointVenture)

Fetch a single JointVenture entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

jointVenture - Joint Venture

Constraints: Not nullable, Maximum length: 6

Returns:

A request builder to fetch a single JointVenture 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.

createJointVenture

@Nonnull
CreateRequestBuilder<JointVenture> createJointVenture(@Nonnull
                                                               JointVenture jointVenture)

Create a new JointVenture entity and save it to the S/4HANA system.

Parameters:

jointVenture - JointVenture entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new JointVenture entity. To perform execution, call the execute method on the request builder object.

updateJointVenture

@Nonnull
UpdateRequestBuilder<JointVenture> updateJointVenture(@Nonnull
                                                               JointVenture jointVenture)

Update an existing JointVenture entity and save it to the S/4HANA system.

Parameters:

jointVenture - JointVenture entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing JointVenture entity. To perform execution, call the execute method on the request builder object.

getAllJointVentureDescription

@Nonnull
GetAllRequestBuilder<JointVentureDescription> getAllJointVentureDescription()

Fetch multiple JointVentureDescription entities.

Returns:

A request builder to fetch multiple JointVentureDescription 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.

countJointVentureDescription

@Nonnull
CountRequestBuilder<JointVentureDescription> countJointVentureDescription()

Fetch the number of entries from the JointVentureDescription entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of JointVentureDescription 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.

getJointVentureDescriptionByKey

@Nonnull
GetByKeyRequestBuilder<JointVentureDescription> getJointVentureDescriptionByKey(@Nonnull
                                                                                         String companyCode,
                                                                                         @Nonnull
                                                                                         String language,
                                                                                         @Nonnull
                                                                                         String jointVenture)

Fetch a single JointVentureDescription entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

jointVenture - Joint Venture

Constraints: Not nullable, Maximum length: 6

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

A request builder to fetch a single JointVentureDescription 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.

createJointVentureDescription

@Nonnull
CreateRequestBuilder<JointVentureDescription> createJointVentureDescription(@Nonnull
                                                                                     JointVentureDescription jointVentureDescription)

Create a new JointVentureDescription entity and save it to the S/4HANA system.

Parameters:

jointVentureDescription - JointVentureDescription entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new JointVentureDescription entity. To perform execution, call the execute method on the request builder object.

updateJointVentureDescription

@Nonnull
UpdateRequestBuilder<JointVentureDescription> updateJointVentureDescription(@Nonnull
                                                                                     JointVentureDescription jointVentureDescription)

Update an existing JointVentureDescription entity and save it to the S/4HANA system.

Parameters:

jointVentureDescription - JointVentureDescription entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing JointVentureDescription entity. To perform execution, call the execute method on the request builder object.

getAllJointVentureEquityGroup

@Nonnull
GetAllRequestBuilder<JointVentureEquityGroup> getAllJointVentureEquityGroup()

Fetch multiple JointVentureEquityGroup entities.

Returns:

A request builder to fetch multiple JointVentureEquityGroup 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.

countJointVentureEquityGroup

@Nonnull
CountRequestBuilder<JointVentureEquityGroup> countJointVentureEquityGroup()

Fetch the number of entries from the JointVentureEquityGroup entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of JointVentureEquityGroup 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.

getJointVentureEquityGroupByKey

@Nonnull
GetByKeyRequestBuilder<JointVentureEquityGroup> getJointVentureEquityGroupByKey(@Nonnull
                                                                                         String companyCode,
                                                                                         @Nonnull
                                                                                         String jointVenture,
                                                                                         @Nonnull
                                                                                         String jntOpgAgrmtEquityGrp)

Fetch a single JointVentureEquityGroup entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

jointVenture - Joint Venture

Constraints: Not nullable, Maximum length: 6

jntOpgAgrmtEquityGrp - Equity Group

Constraints: Not nullable, Maximum length: 3

Returns:

A request builder to fetch a single JointVentureEquityGroup 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.

createJointVentureEquityGroup

@Nonnull
CreateRequestBuilder<JointVentureEquityGroup> createJointVentureEquityGroup(@Nonnull
                                                                                     JointVentureEquityGroup jointVentureEquityGroup)

Create a new JointVentureEquityGroup entity and save it to the S/4HANA system.

Parameters:

jointVentureEquityGroup - JointVentureEquityGroup entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new JointVentureEquityGroup entity. To perform execution, call the execute method on the request builder object.

updateJointVentureEquityGroup

@Nonnull
UpdateRequestBuilder<JointVentureEquityGroup> updateJointVentureEquityGroup(@Nonnull
                                                                                     JointVentureEquityGroup jointVentureEquityGroup)

Update an existing JointVentureEquityGroup entity and save it to the S/4HANA system.

Parameters:

jointVentureEquityGroup - JointVentureEquityGroup entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing JointVentureEquityGroup entity. To perform execution, call the execute method on the request builder object.

getAllJointVentureEquityType

@Nonnull
GetAllRequestBuilder<JointVentureEquityType> getAllJointVentureEquityType()

Fetch multiple JointVentureEquityType entities.

Returns:

A request builder to fetch multiple JointVentureEquityType 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.

countJointVentureEquityType

@Nonnull
CountRequestBuilder<JointVentureEquityType> countJointVentureEquityType()

Fetch the number of entries from the JointVentureEquityType entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of JointVentureEquityType 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.

getJointVentureEquityTypeByKey

@Nonnull
GetByKeyRequestBuilder<JointVentureEquityType> getJointVentureEquityTypeByKey(@Nonnull
                                                                                       String companyCode,
                                                                                       @Nonnull
                                                                                       String jointVenture,
                                                                                       @Nonnull
                                                                                       String jointVentureEquityType,
                                                                                       @Nonnull
                                                                                       String jointVentureEquityFundingDate)

Fetch a single JointVentureEquityType entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

jointVentureEquityType - Equity Type

Constraints: Not nullable, Maximum length: 3

jointVenture - Joint Venture

Constraints: Not nullable, Maximum length: 6

jointVentureEquityFundingDate - Valid from date (inverted: 99999999 - YYYYMMDD)

Constraints: Not nullable, Maximum length: 8

Returns:

A request builder to fetch a single JointVentureEquityType 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.

createJointVentureEquityType

@Nonnull
CreateRequestBuilder<JointVentureEquityType> createJointVentureEquityType(@Nonnull
                                                                                   JointVentureEquityType jointVentureEquityType)

Create a new JointVentureEquityType entity and save it to the S/4HANA system.

Parameters:

jointVentureEquityType - JointVentureEquityType entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new JointVentureEquityType entity. To perform execution, call the execute method on the request builder object.

updateJointVentureEquityType

@Nonnull
UpdateRequestBuilder<JointVentureEquityType> updateJointVentureEquityType(@Nonnull
                                                                                   JointVentureEquityType jointVentureEquityType)

Update an existing JointVentureEquityType entity and save it to the S/4HANA system.

Parameters:

jointVentureEquityType - JointVentureEquityType entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing JointVentureEquityType entity. To perform execution, call the execute method on the request builder object.