public class AssignDocumentToBusinessObjectFluentHelper extends FluentHelperFunction<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
entityCollection
Constructor and Description |
---|
AssignDocumentToBusinessObjectFluentHelper(String servicePath,
String targetSAPObjectType,
String targetSAPObjectNodeType,
String targetBusinessObjectTypeName,
String targetLinkedSAPObjectKey,
String archiveDocumentID,
String sourceSAPObjectType,
String sourceSAPObjectNodeType,
String sourceBusinessObjectTypeName,
String sourceLinkedSAPObjectKey)
Creates a fluent helper object that will execute the AssignDocumentToBusinessObject OData function import
with the provided parameters.
|
Modifier and Type | Method and Description |
---|---|
protected org.apache.http.client.methods.HttpUriRequest |
createRequest(URI uri)
Creates a request for this function based on the given
URI . |
AssignDocument |
execute(HttpDestinationProperties destination)
Deprecated.
Use the improved method
executeRequest(HttpDestinationProperties) instead. |
protected Class<AssignDocument> |
getEntityClass()
Returns a class object of the type this fluent helper works with.
|
protected String |
getFunctionName()
The exact name of the function to be called on the OData Endpoint.
|
protected Map<String,Object> |
getParameters()
Getter for the map of parameters to be used in the function call.
|
protected com.google.gson.JsonElement |
refineJsonResponse(com.google.gson.JsonElement jsonElement)
Transform the JSON element from the response to extract a result entity.
|
executeMultiple, executeRequest, executeSingle, getJsonResponseObjectName, toRequest
and, cachingMetadata, getHeaders, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, onRequestAndImplicitRequests, onRequestOnly, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter
public AssignDocumentToBusinessObjectFluentHelper(@Nonnull String servicePath, @Nullable String targetSAPObjectType, @Nullable String targetSAPObjectNodeType, @Nullable String targetBusinessObjectTypeName, @Nonnull String targetLinkedSAPObjectKey, @Nullable String archiveDocumentID, @Nullable String sourceSAPObjectType, @Nullable String sourceSAPObjectNodeType, @Nullable String sourceBusinessObjectTypeName, @Nonnull String sourceLinkedSAPObjectKey)
execute
method on the fluent helper
object.targetLinkedSAPObjectKey
- TargetLinkedSAPObjectKey
Constraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: TargetLinkedSAPObjectKey
sourceSAPObjectNodeType
- SourceSAPObjectNodeType
Constraints: Nullable, Maximum length: 30
Original parameter name from the Odata EDM: SourceSAPObjectNodeType
sourceSAPObjectType
- SourceSAPObjectType
Constraints: Nullable, Maximum length: 30
Original parameter name from the Odata EDM: SourceSAPObjectType
sourceLinkedSAPObjectKey
- SourceLinkedSAPObjectKey
Constraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: SourceLinkedSAPObjectKey
targetBusinessObjectTypeName
- TargetBusinessObjectTypeName
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: TargetBusinessObjectTypeName
servicePath
- Service path to be used to call the functions against.archiveDocumentID
- ArchiveDocumentID
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: ArchiveDocumentID
targetSAPObjectNodeType
- TargetSAPObjectNodeType
Constraints: Nullable, Maximum length: 30
Original parameter name from the Odata EDM: TargetSAPObjectNodeType
sourceBusinessObjectTypeName
- SourceBusinessObjectTypeName
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: SourceBusinessObjectTypeName
targetSAPObjectType
- TargetSAPObjectType
Constraints: Nullable, Maximum length: 30
Original parameter name from the Odata EDM: TargetSAPObjectType
@Nonnull protected Class<AssignDocument> getEntityClass()
FluentHelperBasic
getEntityClass
in class FluentHelperBasic<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
@Nonnull protected String getFunctionName()
FluentHelperFunction
getFunctionName
in class FluentHelperFunction<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
@Nullable protected com.google.gson.JsonElement refineJsonResponse(@Nullable com.google.gson.JsonElement jsonElement)
FluentHelperFunction
refineJsonResponse
in class FluentHelperFunction<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
jsonElement
- The optional response JSON element@Nonnull protected Map<String,Object> getParameters()
FluentHelperFunction
The map maps the ODataName of a parameter to the corresponding value.
getParameters
in class FluentHelperFunction<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
@Nonnull protected org.apache.http.client.methods.HttpUriRequest createRequest(@Nonnull URI uri)
FluentHelperFunction
URI
.
Examples for such requests are HttpGet
and HttpPost
.
createRequest
in class FluentHelperFunction<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
uri
- The URI
the request should target.@Deprecated @Nullable public AssignDocument execute(@Nonnull HttpDestinationProperties destination) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
executeRequest(HttpDestinationProperties)
instead.execute
in class FluentHelperBasic<AssignDocumentToBusinessObjectFluentHelper,AssignDocument,AssignDocument>
destination
- The destination to use for the request.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- The exception occurred during request executionCopyright © 2021 SAP SE. All rights reserved.