Class DefaultLabelFieldCatalogService
- All Implemented Interfaces:
OperationsOnEntityCollections,ServiceWithNavigableEntities,LabelFieldCatalogService
This service enables you to retrieve label field placeholders from your SAP S/4HANA system and use them in the process of designing label templates in external systems. The service contains all relevant information about a label field placeholder such as ID, version, and the group that it belongs to..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | LABELFIELDCATALOG_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Product Compliance - Label Template Authoring Integration(SAP_COM_0772) |
| Scope Items: | Label Management(6MT) |
| Authentication Methods: | x509 |
| Service Group Name: | API_PRODCMPLNCLBLFLDCTLG |
| Business Object: | Product Compliance Label Field Group |
-
Field Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.LabelFieldCatalogService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingLabelFieldCatalogService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theLabelFieldGroupentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldGroupTextentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldVersionentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldVersionTextentity collection matching the filter and search expressions.Deprecated.Fetch multipleLabelFieldGroupentities.Deprecated.Fetch multipleLabelFieldGroupTextentities.Deprecated.Fetch multipleLabelFieldVersionentities.Deprecated.Fetch multipleLabelFieldVersionTextentities.getLabelFieldGroupByKey(String prodCmplncLabelFieldGroupID) Deprecated.Fetch a singleLabelFieldGroupentity using key fields.getLabelFieldGroupTextByKey(String prodCmplncLabelFieldGroupID, String language) Deprecated.Fetch a singleLabelFieldGroupTextentity using key fields.getLabelFieldVersionByKey(String prodCmplncLabelFieldVersionID) Deprecated.Fetch a singleLabelFieldVersionentity using key fields.getLabelFieldVersionTextByKey(String prodCmplncLabelFieldVersionID, String language) Deprecated.Fetch a singleLabelFieldVersionTextentity using key fields.Deprecated.withServicePath(String servicePath) Deprecated.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, waitMethods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities
applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction
-
Constructor Details
-
DefaultLabelFieldCatalogService
public DefaultLabelFieldCatalogService()Deprecated.Creates a service usingLabelFieldCatalogService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
Deprecated.Description copied from interface:LabelFieldCatalogServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfaceLabelFieldCatalogService- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.Description copied from interface:LabelFieldCatalogServiceCreates a batch request builder object.- Specified by:
batchin interfaceLabelFieldCatalogService- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllLabelFieldGroup
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch multipleLabelFieldGroupentities.- Specified by:
getAllLabelFieldGroupin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch multiple
LabelFieldGroupentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countLabelFieldGroup
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch the number of entries from theLabelFieldGroupentity collection matching the filter and search expressions.- Specified by:
countLabelFieldGroupin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch the count of
LabelFieldGroupentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getLabelFieldGroupByKey
@Nonnull public GetByKeyRequestBuilder<LabelFieldGroup> getLabelFieldGroupByKey(String prodCmplncLabelFieldGroupID) Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch a singleLabelFieldGroupentity using key fields.- Specified by:
getLabelFieldGroupByKeyin interfaceLabelFieldCatalogService- Parameters:
prodCmplncLabelFieldGroupID- Label Field Group IDConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelFieldGroupentity 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 theexecutemethod on the request builder object.
-
getAllLabelFieldGroupText
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch multipleLabelFieldGroupTextentities.- Specified by:
getAllLabelFieldGroupTextin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch multiple
LabelFieldGroupTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countLabelFieldGroupText
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch the number of entries from theLabelFieldGroupTextentity collection matching the filter and search expressions.- Specified by:
countLabelFieldGroupTextin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch the count of
LabelFieldGroupTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getLabelFieldGroupTextByKey
@Nonnull public GetByKeyRequestBuilder<LabelFieldGroupText> getLabelFieldGroupTextByKey(String prodCmplncLabelFieldGroupID, String language) Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch a singleLabelFieldGroupTextentity using key fields.- Specified by:
getLabelFieldGroupTextByKeyin interfaceLabelFieldCatalogService- Parameters:
prodCmplncLabelFieldGroupID- Label Field Group IDConstraints: Not nullable, Maximum length: 21
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
LabelFieldGroupTextentity 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 theexecutemethod on the request builder object.
-
getAllLabelFieldVersion
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch multipleLabelFieldVersionentities.- Specified by:
getAllLabelFieldVersionin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch multiple
LabelFieldVersionentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countLabelFieldVersion
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch the number of entries from theLabelFieldVersionentity collection matching the filter and search expressions.- Specified by:
countLabelFieldVersionin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch the count of
LabelFieldVersionentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getLabelFieldVersionByKey
@Nonnull public GetByKeyRequestBuilder<LabelFieldVersion> getLabelFieldVersionByKey(String prodCmplncLabelFieldVersionID) Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch a singleLabelFieldVersionentity using key fields.- Specified by:
getLabelFieldVersionByKeyin interfaceLabelFieldCatalogService- Parameters:
prodCmplncLabelFieldVersionID- Label Field Version IdentificatorConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelFieldVersionentity 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 theexecutemethod on the request builder object.
-
getAllLabelFieldVersionText
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch multipleLabelFieldVersionTextentities.- Specified by:
getAllLabelFieldVersionTextin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch multiple
LabelFieldVersionTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countLabelFieldVersionText
Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch the number of entries from theLabelFieldVersionTextentity collection matching the filter and search expressions.- Specified by:
countLabelFieldVersionTextin interfaceLabelFieldCatalogService- Returns:
- A request builder to fetch the count of
LabelFieldVersionTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getLabelFieldVersionTextByKey
@Nonnull public GetByKeyRequestBuilder<LabelFieldVersionText> getLabelFieldVersionTextByKey(String prodCmplncLabelFieldVersionID, String language) Deprecated.Description copied from interface:LabelFieldCatalogServiceFetch a singleLabelFieldVersionTextentity using key fields.- Specified by:
getLabelFieldVersionTextByKeyin interfaceLabelFieldCatalogService- Parameters:
prodCmplncLabelFieldVersionID- Label Field Version IdentificatorConstraints: Not nullable, Maximum length: 21
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
LabelFieldVersionTextentity 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 theexecutemethod on the request builder object.
-
getServicePath
Deprecated.- Specified by:
getServicePathin interfaceServiceWithNavigableEntities
-