Interface LegalContextService
- All Known Implementing Classes:
DefaultLegalContextService
Legal contexts are templates for legal transactions that predefines how a legal transaction must be processed; what information must be provided; which parties are involved and so on. The service contains legal context and legal context text nodes. The information sent in the request payload is used while creating a legal context, including appropriate checks for restricted values and authorizations. Once the legal context is created, the legal context ID is sent in the response. If there are any issues when the legal context is created, the system displays error messages in the response. For more information, refer to the business documentation of this API. .
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CE_LEGALCONTEXT_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Legal Context Integration(SAP_COM_0791) |
| Scope Items: | SAP S/4HANA for Enterprise Contract Management(1XV) |
| Authentication Methods: | x509 |
| Service Group Name: | API_LEGALCONTEXT |
| Business Object: | Legal Context |
-
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 theLegalContextentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextCategoryentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextCategoryGroupentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextDateentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextEntityentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalCotextExternalContactentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextIntContactentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextLinkedObjectentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextParentCategoryentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLegalContextRelationshipentity collection matching the filter and search expressions.Deprecated.Fetch multipleLegalContextentities.Deprecated.Fetch multipleLegalContextCategoryentities.Deprecated.Fetch multipleLegalContextCategoryGroupentities.Deprecated.Fetch multipleLegalContextDateentities.Deprecated.Fetch multipleLegalContextEntityentities.Deprecated.Fetch multipleLegalCotextExternalContactentities.Deprecated.Fetch multipleLegalContextIntContactentities.Deprecated.Fetch multipleLegalContextLinkedObjectentities.Deprecated.Fetch multipleLegalContextParentCategoryentities.Deprecated.Fetch multipleLegalContextRelationshipentities.getLegalContextByKey(UUID lglCntntMContextUUID) Deprecated.Fetch a singleLegalContextentity using key fields.getLegalContextCategoryByKey(UUID lglCntntMCntxtCategoryUUID) Deprecated.Fetch a singleLegalContextCategoryentity using key fields.getLegalContextCategoryGroupByKey(UUID lglCntntMCntxtCatGroupUUID) Deprecated.Fetch a singleLegalContextCategoryGroupentity using key fields.getLegalContextDateByKey(UUID lglCntntMCntxtDateUUID) Deprecated.Fetch a singleLegalContextDateentity using key fields.getLegalContextEntityByKey(UUID lglCntntMCntxtEntityUUID) Deprecated.Fetch a singleLegalContextEntityentity using key fields.getLegalContextExternalContactByKey(UUID lglCntntMCntxtExtCntctUUID) Deprecated.Fetch a singleLegalCotextExternalContactentity using key fields.getLegalContextInternalContactByKey(UUID lglCntntMCntxtIntCntctUUID) Deprecated.Fetch a singleLegalContextIntContactentity using key fields.getLegalContextLinkedObjectByKey(UUID lglCntntMCntxtLinkObjUUID) Deprecated.Fetch a singleLegalContextLinkedObjectentity using key fields.getLegalContextParentCategoryByKey(UUID lglCntntMCntxtParCategoryUUID) Deprecated.Fetch a singleLegalContextParentCategoryentity using key fields.getLegalContextRelationshipByKey(UUID lglCntntMCntxtRelshpUUID) Deprecated.Fetch a singleLegalContextRelationshipentity using key fields.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.
-
getAllLegalContext
Deprecated.Fetch multipleLegalContextentities.- Returns:
- A request builder to fetch multiple
LegalContextentities. 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.
-
countLegalContext
Deprecated.Fetch the number of entries from theLegalContextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextentities. 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.
-
getLegalContextByKey
Deprecated.Fetch a singleLegalContextentity using key fields.- Parameters:
lglCntntMContextUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextentity 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.
-
getAllLegalContextCategory
Deprecated.Fetch multipleLegalContextCategoryentities.- Returns:
- A request builder to fetch multiple
LegalContextCategoryentities. 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.
-
countLegalContextCategory
Deprecated.Fetch the number of entries from theLegalContextCategoryentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextCategoryentities. 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.
-
getLegalContextCategoryByKey
@Nonnull GetByKeyRequestBuilder<LegalContextCategory> getLegalContextCategoryByKey(UUID lglCntntMCntxtCategoryUUID) Deprecated.Fetch a singleLegalContextCategoryentity using key fields.- Parameters:
lglCntntMCntxtCategoryUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextCategoryentity 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.
-
getAllLegalContextCategoryGroup
Deprecated.Fetch multipleLegalContextCategoryGroupentities.- Returns:
- A request builder to fetch multiple
LegalContextCategoryGroupentities. 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.
-
countLegalContextCategoryGroup
Deprecated.Fetch the number of entries from theLegalContextCategoryGroupentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextCategoryGroupentities. 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.
-
getLegalContextCategoryGroupByKey
@Nonnull GetByKeyRequestBuilder<LegalContextCategoryGroup> getLegalContextCategoryGroupByKey(UUID lglCntntMCntxtCatGroupUUID) Deprecated.Fetch a singleLegalContextCategoryGroupentity using key fields.- Parameters:
lglCntntMCntxtCatGroupUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextCategoryGroupentity 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.
-
getAllLegalContextDate
Deprecated.Fetch multipleLegalContextDateentities.- Returns:
- A request builder to fetch multiple
LegalContextDateentities. 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.
-
countLegalContextDate
Deprecated.Fetch the number of entries from theLegalContextDateentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextDateentities. 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.
-
getLegalContextDateByKey
@Nonnull GetByKeyRequestBuilder<LegalContextDate> getLegalContextDateByKey(UUID lglCntntMCntxtDateUUID) Deprecated.Fetch a singleLegalContextDateentity using key fields.- Parameters:
lglCntntMCntxtDateUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextDateentity 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.
-
getAllLegalContextEntity
Deprecated.Fetch multipleLegalContextEntityentities.- Returns:
- A request builder to fetch multiple
LegalContextEntityentities. 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.
-
countLegalContextEntity
Deprecated.Fetch the number of entries from theLegalContextEntityentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextEntityentities. 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.
-
getLegalContextEntityByKey
@Nonnull GetByKeyRequestBuilder<LegalContextEntity> getLegalContextEntityByKey(UUID lglCntntMCntxtEntityUUID) Deprecated.Fetch a singleLegalContextEntityentity using key fields.- Parameters:
lglCntntMCntxtEntityUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextEntityentity 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.
-
getAllLegalContextExternalContact
Deprecated.Fetch multipleLegalCotextExternalContactentities.- Returns:
- A request builder to fetch multiple
LegalCotextExternalContactentities. 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.
-
countLegalContextExternalContact
Deprecated.Fetch the number of entries from theLegalCotextExternalContactentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalCotextExternalContactentities. 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.
-
getLegalContextExternalContactByKey
@Nonnull GetByKeyRequestBuilder<LegalCotextExternalContact> getLegalContextExternalContactByKey(UUID lglCntntMCntxtExtCntctUUID) Deprecated.Fetch a singleLegalCotextExternalContactentity using key fields.- Parameters:
lglCntntMCntxtExtCntctUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalCotextExternalContactentity 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.
-
getAllLegalContextInternalContact
Deprecated.Fetch multipleLegalContextIntContactentities.- Returns:
- A request builder to fetch multiple
LegalContextIntContactentities. 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.
-
countLegalContextInternalContact
Deprecated.Fetch the number of entries from theLegalContextIntContactentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextIntContactentities. 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.
-
getLegalContextInternalContactByKey
@Nonnull GetByKeyRequestBuilder<LegalContextIntContact> getLegalContextInternalContactByKey(UUID lglCntntMCntxtIntCntctUUID) Deprecated.Fetch a singleLegalContextIntContactentity using key fields.- Parameters:
lglCntntMCntxtIntCntctUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextIntContactentity 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.
-
getAllLegalContextLinkedObject
Deprecated.Fetch multipleLegalContextLinkedObjectentities.- Returns:
- A request builder to fetch multiple
LegalContextLinkedObjectentities. 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.
-
countLegalContextLinkedObject
Deprecated.Fetch the number of entries from theLegalContextLinkedObjectentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextLinkedObjectentities. 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.
-
getLegalContextLinkedObjectByKey
@Nonnull GetByKeyRequestBuilder<LegalContextLinkedObject> getLegalContextLinkedObjectByKey(UUID lglCntntMCntxtLinkObjUUID) Deprecated.Fetch a singleLegalContextLinkedObjectentity using key fields.- Parameters:
lglCntntMCntxtLinkObjUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextLinkedObjectentity 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.
-
getAllLegalContextParentCategory
Deprecated.Fetch multipleLegalContextParentCategoryentities.- Returns:
- A request builder to fetch multiple
LegalContextParentCategoryentities. 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.
-
countLegalContextParentCategory
Deprecated.Fetch the number of entries from theLegalContextParentCategoryentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextParentCategoryentities. 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.
-
getLegalContextParentCategoryByKey
@Nonnull GetByKeyRequestBuilder<LegalContextParentCategory> getLegalContextParentCategoryByKey(UUID lglCntntMCntxtParCategoryUUID) Deprecated.Fetch a singleLegalContextParentCategoryentity using key fields.- Parameters:
lglCntntMCntxtParCategoryUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextParentCategoryentity 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.
-
getAllLegalContextRelationship
Deprecated.Fetch multipleLegalContextRelationshipentities.- Returns:
- A request builder to fetch multiple
LegalContextRelationshipentities. 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.
-
countLegalContextRelationship
Deprecated.Fetch the number of entries from theLegalContextRelationshipentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LegalContextRelationshipentities. 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.
-
getLegalContextRelationshipByKey
@Nonnull GetByKeyRequestBuilder<LegalContextRelationship> getLegalContextRelationshipByKey(UUID lglCntntMCntxtRelshpUUID) Deprecated.Fetch a singleLegalContextRelationshipentity using key fields.- Parameters:
lglCntntMCntxtRelshpUUID- Universal Unique IdentifierConstraints: Not nullable
- Returns:
- A request builder to fetch a single
LegalContextRelationshipentity 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.
-