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

Class DefaultCharacteristicAttributeCatalogService

java.lang.Object

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

All Implemented Interfaces:

BatchService<CharacteristicAttributeCatalogServiceBatch>, CharacteristicAttributeCatalogService

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

This service enables you to read catalog data for characteristic attributes from the SAP S/4HANA Cloud system. The catalog data consists of plant-specific selected sets with their codes that are used to document the quality inspection results for qualitative characteristics.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CHARCATTRIBUTECATALOG_SRV
API Version:	1
Communication Scenario:	Inspection Master Data Integration (SAP_COM_0110)
Scope Items:	Quality Management in Discrete Manufacturing (1E1), Quality Management in Procurement (1FM), Quality Management in Sales (1MP), Quality Management in Stock Handling (1MR), Nonconformance Management (2QN)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	CharcAttributeSelectedCodeSet

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCharacteristicAttributeCatalogService() Creates a service using CharacteristicAttributeCatalogService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultCharacteristicAttributeCatalogServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
CharcAttribSeldCodeSetFluentHelper	getAllCharcAttribSeldCodeSet() Fetch multiple CharcAttribSeldCodeSet entities.
CharcAttribSeldSetCodeFluentHelper	getAllCharcAttribSeldSetCode() Fetch multiple CharcAttribSeldSetCode entities.
CharcAttribSeldSetCodeTFluentHelper	getAllCharcAttribSeldSetCodeT() Fetch multiple CharcAttribSeldSetCodeT entities.
CharcAttribSeldSetTFluentHelper	getAllCharcAttribSeldSetT() Fetch multiple CharcAttribSeldSetT entities.
CharcAttribSeldCodeSetByKeyFluentHelper	getCharcAttribSeldCodeSetByKey(String selectedCodeSetPlant, String selectedCodeSet) Fetch a single CharcAttribSeldCodeSet entity using key fields.
CharcAttribSeldSetCodeByKeyFluentHelper	getCharcAttribSeldSetCodeByKey(String selectedCodeSetPlant, String selectedCodeSet, String characteristicAttributeCodeGrp, String characteristicAttributeCode) Fetch a single CharcAttribSeldSetCode entity using key fields.
CharcAttribSeldSetCodeTByKeyFluentHelper	getCharcAttribSeldSetCodeTByKey(String selectedCodeSetPlant, String selectedCodeSet, String characteristicAttributeCodeGrp, String characteristicAttributeCode, String language) Fetch a single CharcAttribSeldSetCodeT entity using key fields.
CharcAttribSeldSetTByKeyFluentHelper	getCharcAttribSeldSetTByKey(String selectedCodeSetPlant, String selectedCodeSet, String language) Fetch a single CharcAttribSeldSetT entity using key fields.
DefaultCharacteristicAttributeCatalogService	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

DefaultCharacteristicAttributeCatalogService

public DefaultCharacteristicAttributeCatalogService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCharacteristicAttributeCatalogService withServicePath(@Nonnull
                                                                             String servicePath)

Description copied from interface: CharacteristicAttributeCatalogService

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 CharacteristicAttributeCatalogService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCharacteristicAttributeCatalogServiceBatch batch()

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

Specified by:

batch in interface BatchService<CharacteristicAttributeCatalogServiceBatch>

Returns:

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

getAllCharcAttribSeldCodeSet

@Nonnull
public CharcAttribSeldCodeSetFluentHelper getAllCharcAttribSeldCodeSet()

Description copied from interface: CharacteristicAttributeCatalogService

Fetch multiple CharcAttribSeldCodeSet entities.

Specified by:

getAllCharcAttribSeldCodeSet in interface CharacteristicAttributeCatalogService

Returns:

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

getCharcAttribSeldCodeSetByKey

@Nonnull
public CharcAttribSeldCodeSetByKeyFluentHelper getCharcAttribSeldCodeSetByKey(String selectedCodeSetPlant,
                                                                                       String selectedCodeSet)

Description copied from interface: CharacteristicAttributeCatalogService

Fetch a single CharcAttribSeldCodeSet entity using key fields.

Specified by:

getCharcAttribSeldCodeSetByKey in interface CharacteristicAttributeCatalogService

Parameters:

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

Returns:

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

getAllCharcAttribSeldSetCode

@Nonnull
public CharcAttribSeldSetCodeFluentHelper getAllCharcAttribSeldSetCode()

Description copied from interface: CharacteristicAttributeCatalogService

Fetch multiple CharcAttribSeldSetCode entities.

Specified by:

getAllCharcAttribSeldSetCode in interface CharacteristicAttributeCatalogService

Returns:

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

getCharcAttribSeldSetCodeByKey

@Nonnull
public CharcAttribSeldSetCodeByKeyFluentHelper getCharcAttribSeldSetCodeByKey(String selectedCodeSetPlant,
                                                                                       String selectedCodeSet,
                                                                                       String characteristicAttributeCodeGrp,
                                                                                       String characteristicAttributeCode)

Description copied from interface: CharacteristicAttributeCatalogService

Fetch a single CharcAttribSeldSetCode entity using key fields.

Specified by:

getCharcAttribSeldSetCodeByKey in interface CharacteristicAttributeCatalogService

Parameters:

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCodeGrp - Key for the code group.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCode - Represents the lowest level within the hierarchy of catalog type, code group and code. A code refers to the actual coding for the attribute. For example, in a code group of colors, the code BL can represent the color blue, GR can represent the color green, and so forth.

Constraints: Not nullable, Maximum length: 4

Returns:

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

getAllCharcAttribSeldSetCodeT

@Nonnull
public CharcAttribSeldSetCodeTFluentHelper getAllCharcAttribSeldSetCodeT()

Description copied from interface: CharacteristicAttributeCatalogService

Fetch multiple CharcAttribSeldSetCodeT entities.

Specified by:

getAllCharcAttribSeldSetCodeT in interface CharacteristicAttributeCatalogService

Returns:

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

getCharcAttribSeldSetCodeTByKey

@Nonnull
public CharcAttribSeldSetCodeTByKeyFluentHelper getCharcAttribSeldSetCodeTByKey(String selectedCodeSetPlant,
                                                                                         String selectedCodeSet,
                                                                                         String characteristicAttributeCodeGrp,
                                                                                         String characteristicAttributeCode,
                                                                                         String language)

Description copied from interface: CharacteristicAttributeCatalogService

Fetch a single CharcAttribSeldSetCodeT entity using key fields.

Specified by:

getCharcAttribSeldSetCodeTByKey in interface CharacteristicAttributeCatalogService

Parameters:

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCodeGrp - Key for the code group.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCode - Represents the lowest level within the hierarchy of catalog type, code group and code. A code refers to the actual coding for the attribute. For example, in a code group of colors, the code BL can represent the color blue, GR can represent the color green, and so forth.

Constraints: Not nullable, Maximum length: 4

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllCharcAttribSeldSetT

@Nonnull
public CharcAttribSeldSetTFluentHelper getAllCharcAttribSeldSetT()

Description copied from interface: CharacteristicAttributeCatalogService

Fetch multiple CharcAttribSeldSetT entities.

Specified by:

getAllCharcAttribSeldSetT in interface CharacteristicAttributeCatalogService

Returns:

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

getCharcAttribSeldSetTByKey

@Nonnull
public CharcAttribSeldSetTByKeyFluentHelper getCharcAttribSeldSetTByKey(String selectedCodeSetPlant,
                                                                                 String selectedCodeSet,
                                                                                 String language)

Description copied from interface: CharacteristicAttributeCatalogService

Fetch a single CharcAttribSeldSetT entity using key fields.

Specified by:

getCharcAttribSeldSetTByKey in interface CharacteristicAttributeCatalogService

Parameters:

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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