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

Interface CharacteristicAttributeCatalogService

All Superinterfaces:

BatchService<CharacteristicAttributeCatalogServiceBatch>

All Known Implementing Classes:

DefaultCharacteristicAttributeCatalogService

public interface CharacteristicAttributeCatalogService
extends BatchService<CharacteristicAttributeCatalogServiceBatch>

The catalog data that is read with this service consists of plant- specific selected sets with their codes that are used to record inspection results for qualitative characteristics, for example, the codes 01 (Smooth) and 02 (Rough) for the characteristic ***Surface***..

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

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
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.
CharacteristicAttributeCatalogService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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

getAllCharcAttribSeldCodeSet

@Nonnull
CharcAttribSeldCodeSetFluentHelper getAllCharcAttribSeldCodeSet()

Fetch multiple CharcAttribSeldCodeSet entities.

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
CharcAttribSeldCodeSetByKeyFluentHelper getCharcAttribSeldCodeSetByKey(String selectedCodeSetPlant,
                                                                                String selectedCodeSet)

Fetch a single CharcAttribSeldCodeSet entity using key fields.

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
CharcAttribSeldSetCodeFluentHelper getAllCharcAttribSeldSetCode()

Fetch multiple CharcAttribSeldSetCode entities.

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
CharcAttribSeldSetCodeByKeyFluentHelper getCharcAttribSeldSetCodeByKey(String selectedCodeSetPlant,
                                                                                String selectedCodeSet,
                                                                                String characteristicAttributeCodeGrp,
                                                                                String characteristicAttributeCode)

Fetch a single CharcAttribSeldSetCode entity using key fields.

Parameters:

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

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

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCodeGrp - Key for the code group.

Constraints: Not nullable, Maximum length: 8

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
CharcAttribSeldSetCodeTFluentHelper getAllCharcAttribSeldSetCodeT()

Fetch multiple CharcAttribSeldSetCodeT entities.

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
CharcAttribSeldSetCodeTByKeyFluentHelper getCharcAttribSeldSetCodeTByKey(String selectedCodeSetPlant,
                                                                                  String selectedCodeSet,
                                                                                  String characteristicAttributeCodeGrp,
                                                                                  String characteristicAttributeCode,
                                                                                  String language)

Fetch a single CharcAttribSeldSetCodeT entity using key fields.

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

selectedCodeSetPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

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

selectedCodeSet - Key for the selected set.

Constraints: Not nullable, Maximum length: 8

characteristicAttributeCodeGrp - Key for the code group.

Constraints: Not nullable, Maximum length: 8

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
CharcAttribSeldSetTFluentHelper getAllCharcAttribSeldSetT()

Fetch multiple CharcAttribSeldSetT entities.

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
CharcAttribSeldSetTByKeyFluentHelper getCharcAttribSeldSetTByKey(String selectedCodeSetPlant,
                                                                          String selectedCodeSet,
                                                                          String language)

Fetch a single CharcAttribSeldSetT entity using key fields.

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

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