Interface ConsolidationSegmentService
- All Known Implementing Classes:
DefaultConsolidationSegmentService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the
VDM.
A consolidation segment is a segment that can be used for financial consolidation in group reporting. It can either be a segment that’s been defined in an area other than group reporting, or it can be a segment that’s been specifically defined for exclusive use in group reporting.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CE_CNSLDTNSEGMENT_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Finance - Cloud Consolidation Master Data for Group Reporting Integration(SAP_COM_0336) |
| Scope Items: | Group Reporting - Data from External Systems(2U6) |
| Authentication Methods: | x509 |
| Service Group Name: | API_CNSLDTNSEGMENT |
| Business Object: | Consolidation Segment |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theCnsldtnSegmententity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theCnsldtnSegmentTextentity collection matching the filter and search expressions.createCnsldtnSegment(CnsldtnSegment cnsldtnSegment) Deprecated.Create a newCnsldtnSegmententity and save it to the S/4HANA system.deleteCnsldtnSegment(CnsldtnSegment cnsldtnSegment) Deprecated.Deletes an existingCnsldtnSegmententity in the S/4HANA system.deleteCnsldtnSegmentText(CnsldtnSegmentText cnsldtnSegmentText) Deprecated.Deletes an existingCnsldtnSegmentTextentity in the S/4HANA system.Deprecated.Fetch multipleCnsldtnSegmententities.Deprecated.Fetch multipleCnsldtnSegmentTextentities.getCnsldtnSegmentByKey(String segment) Deprecated.Fetch a singleCnsldtnSegmententity using key fields.getCnsldtnSegmentTextByKey(String language, String segment) Deprecated.Fetch a singleCnsldtnSegmentTextentity using key fields.updateCnsldtnSegment(CnsldtnSegment cnsldtnSegment) Deprecated.Update an existingCnsldtnSegmententity and save it to the S/4HANA system.updateCnsldtnSegmentText(CnsldtnSegmentText cnsldtnSegmentText) Deprecated.Update an existingCnsldtnSegmentTextentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.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
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllCnsldtnSegment
Deprecated.Fetch multipleCnsldtnSegmententities.- Returns:
- A request builder to fetch multiple
CnsldtnSegmententities. 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.
-
countCnsldtnSegment
Deprecated.Fetch the number of entries from theCnsldtnSegmententity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CnsldtnSegmententities. 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.
-
getCnsldtnSegmentByKey
Deprecated.Fetch a singleCnsldtnSegmententity using key fields.- Parameters:
segment- SegmentConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
CnsldtnSegmententity 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.
-
createCnsldtnSegment
@Nonnull CreateRequestBuilder<CnsldtnSegment> createCnsldtnSegment(@Nonnull CnsldtnSegment cnsldtnSegment) Deprecated.Create a newCnsldtnSegmententity and save it to the S/4HANA system.- Parameters:
cnsldtnSegment-CnsldtnSegmententity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
CnsldtnSegmententity. To perform execution, call theexecutemethod on the request builder object.
-
updateCnsldtnSegment
@Nonnull UpdateRequestBuilder<CnsldtnSegment> updateCnsldtnSegment(@Nonnull CnsldtnSegment cnsldtnSegment) Deprecated.Update an existingCnsldtnSegmententity and save it to the S/4HANA system.- Parameters:
cnsldtnSegment-CnsldtnSegmententity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
CnsldtnSegmententity. To perform execution, call theexecutemethod on the request builder object.
-
deleteCnsldtnSegment
@Nonnull DeleteRequestBuilder<CnsldtnSegment> deleteCnsldtnSegment(@Nonnull CnsldtnSegment cnsldtnSegment) Deprecated.Deletes an existingCnsldtnSegmententity in the S/4HANA system.- Parameters:
cnsldtnSegment-CnsldtnSegmententity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
CnsldtnSegmententity. To perform execution, call theexecutemethod on the request builder object.
-
getAllCnsldtnSegmentText
Deprecated.Fetch multipleCnsldtnSegmentTextentities.- Returns:
- A request builder to fetch multiple
CnsldtnSegmentTextentities. 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.
-
countCnsldtnSegmentText
Deprecated.Fetch the number of entries from theCnsldtnSegmentTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CnsldtnSegmentTextentities. 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.
-
getCnsldtnSegmentTextByKey
@Nonnull GetByKeyRequestBuilder<CnsldtnSegmentText> getCnsldtnSegmentTextByKey(String language, String segment) Deprecated.Fetch a singleCnsldtnSegmentTextentity using key fields.- Parameters:
segment- SegmentConstraints: Not nullable, Maximum length: 10
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
CnsldtnSegmentTextentity 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.
-
updateCnsldtnSegmentText
@Nonnull UpdateRequestBuilder<CnsldtnSegmentText> updateCnsldtnSegmentText(@Nonnull CnsldtnSegmentText cnsldtnSegmentText) Deprecated.Update an existingCnsldtnSegmentTextentity and save it to the S/4HANA system.- Parameters:
cnsldtnSegmentText-CnsldtnSegmentTextentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
CnsldtnSegmentTextentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteCnsldtnSegmentText
@Nonnull DeleteRequestBuilder<CnsldtnSegmentText> deleteCnsldtnSegmentText(@Nonnull CnsldtnSegmentText cnsldtnSegmentText) Deprecated.Deletes an existingCnsldtnSegmentTextentity in the S/4HANA system.- Parameters:
cnsldtnSegmentText-CnsldtnSegmentTextentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
CnsldtnSegmentTextentity. To perform execution, call theexecutemethod on the request builder object.
-