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

Class DefaultServiceContractService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ServiceContractServiceBatch>, ServiceContractService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultServiceContractService")
public class DefaultServiceContractService
extends Object
implements ServiceContractService

You can use this service to integrate external applications with service contract processing in SAP S/4HANA Cloud. The service contains entities of service contract header, header text, item, item object list, and item released order. In each API call, you can use the operation to retrieve service contracts. You can apply any of the filters provided or retrieve all existing data..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SERVICE_CONTRACT_SRV
API Version:	1
Communication Scenario:	Service Contract OData Integration (SAP_COM_0558)
Scope Items:	Service Contract Management (3MO)
Authentication Methods:	Basic
Business Object:	ServiceContract

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ServiceContractService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultServiceContractService() Creates a service using ServiceContractService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultServiceContractServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
ServiceContractFluentHelper	getAllServiceContract() Fetch multiple ServiceContract entities.
ServiceContractItemFluentHelper	getAllServiceContractItem() Fetch multiple ServiceContractItem entities.
ServiceContractTextFluentHelper	getAllServiceContractText() Fetch multiple ServiceContractText entities.
ServiceContrItemObjectListFluentHelper	getAllServiceContrItemObjectList() Fetch multiple ServiceContrItemObjectList entities.
ServiceContrItmReleasedOrderFluentHelper	getAllServiceContrItmReleasedOrder() Fetch multiple ServiceContrItmReleasedOrder entities.
ServiceContractByKeyFluentHelper	getServiceContractByKey(String serviceContract) Fetch a single ServiceContract entity using key fields.
ServiceContractItemByKeyFluentHelper	getServiceContractItemByKey(String serviceContract, String serviceContractItem) Fetch a single ServiceContractItem entity using key fields.
ServiceContractTextByKeyFluentHelper	getServiceContractTextByKey(String serviceContract, String language, String longTextID) Fetch a single ServiceContractText entity using key fields.
ServiceContrItemObjectListByKeyFluentHelper	getServiceContrItemObjectListByKey(String serviceContract, String serviceContractItem, String serviceRefObjectSequenceNumber) Fetch a single ServiceContrItemObjectList entity using key fields.
ServiceContrItmReleasedOrderByKeyFluentHelper	getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber) Fetch a single ServiceContrItmReleasedOrder entity using key fields.
DefaultServiceContractService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultServiceContractService

public DefaultServiceContractService()

Creates a service using ServiceContractService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultServiceContractService withServicePath(@Nonnull
                                                              String servicePath)

Description copied from interface: ServiceContractService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface ServiceContractService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultServiceContractServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ServiceContractServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllServiceContract

@Nonnull
public ServiceContractFluentHelper getAllServiceContract()

Description copied from interface: ServiceContractService

Fetch multiple ServiceContract entities.

Specified by:

getAllServiceContract in interface ServiceContractService

Returns:

A fluent helper to fetch multiple ServiceContract 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.

getServiceContractByKey

@Nonnull
public ServiceContractByKeyFluentHelper getServiceContractByKey(String serviceContract)

Description copied from interface: ServiceContractService

Fetch a single ServiceContract entity using key fields.

Specified by:

getServiceContractByKey in interface ServiceContractService

Parameters:

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllServiceContractItem

@Nonnull
public ServiceContractItemFluentHelper getAllServiceContractItem()

Description copied from interface: ServiceContractService

Fetch multiple ServiceContractItem entities.

Specified by:

getAllServiceContractItem in interface ServiceContractService

Returns:

A fluent helper to fetch multiple ServiceContractItem 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.

getServiceContractItemByKey

@Nonnull
public ServiceContractItemByKeyFluentHelper getServiceContractItemByKey(String serviceContract,
                                                                                 String serviceContractItem)

Description copied from interface: ServiceContractService

Fetch a single ServiceContractItem entity using key fields.

Specified by:

getServiceContractItemByKey in interface ServiceContractService

Parameters:

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

serviceContractItem - Shortened Item Number in Document

Constraints: Not nullable, Maximum length: 6

Returns:

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

getAllServiceContractText

@Nonnull
public ServiceContractTextFluentHelper getAllServiceContractText()

Description copied from interface: ServiceContractService

Fetch multiple ServiceContractText entities.

Specified by:

getAllServiceContractText in interface ServiceContractService

Returns:

A fluent helper to fetch multiple ServiceContractText 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.

getServiceContractTextByKey

@Nonnull
public ServiceContractTextByKeyFluentHelper getServiceContractTextByKey(String serviceContract,
                                                                                 String language,
                                                                                 String longTextID)

Description copied from interface: ServiceContractService

Fetch a single ServiceContractText entity using key fields.

Specified by:

getServiceContractTextByKey in interface ServiceContractService

Parameters:

serviceContract - Number which identifies the transaction document. It is unique for the respective business transaction category.

Constraints: Not nullable, Maximum length: 10

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

longTextID - The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

Constraints: Not nullable, Maximum length: 4

Returns:

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

getAllServiceContrItemObjectList

@Nonnull
public ServiceContrItemObjectListFluentHelper getAllServiceContrItemObjectList()

Description copied from interface: ServiceContractService

Fetch multiple ServiceContrItemObjectList entities.

Specified by:

getAllServiceContrItemObjectList in interface ServiceContractService

Returns:

A fluent helper to fetch multiple ServiceContrItemObjectList 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.

getServiceContrItemObjectListByKey

@Nonnull
public ServiceContrItemObjectListByKeyFluentHelper getServiceContrItemObjectListByKey(String serviceContract,
                                                                                               String serviceContractItem,
                                                                                               String serviceRefObjectSequenceNumber)

Description copied from interface: ServiceContractService

Fetch a single ServiceContrItemObjectList entity using key fields.

Specified by:

getServiceContrItemObjectListByKey in interface ServiceContractService

Parameters:

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

serviceContractItem - Shortened Item Number in Document

Constraints: Not nullable, Maximum length: 6

serviceRefObjectSequenceNumber - Reference Object Counter

Constraints: Not nullable, Maximum length: 8

Returns:

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

getAllServiceContrItmReleasedOrder

@Nonnull
public ServiceContrItmReleasedOrderFluentHelper getAllServiceContrItmReleasedOrder()

Description copied from interface: ServiceContractService

Fetch multiple ServiceContrItmReleasedOrder entities.

Specified by:

getAllServiceContrItmReleasedOrder in interface ServiceContractService

Returns:

A fluent helper to fetch multiple ServiceContrItmReleasedOrder 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.

getServiceContrItmReleasedOrderByKey

@Nonnull
public ServiceContrItmReleasedOrderByKeyFluentHelper getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID,
                                                                                                   String serviceDocItmRltnSqncNumber)

Description copied from interface: ServiceContractService

Fetch a single ServiceContrItmReleasedOrder entity using key fields.

Specified by:

getServiceContrItmReleasedOrderByKey in interface ServiceContractService

Parameters:

serviceDocumentItmRelationUUID - Object Relationship Service : GUID binary link

Constraints: Not nullable

serviceDocItmRltnSqncNumber - Sequential Number of Segment in IDoc Type

Constraints: Not nullable, Maximum length: 4

Returns:

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