com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.attachment

Class RenameAttachmentFluentHelper

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,ObjectT,ResultT>

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.attachment.RenameAttachmentFluentHelper

public class RenameAttachmentFluentHelper
extends FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Fluent helper for the RenameAttachment OData function import.

Constructor Summary

Constructors

Constructor and Description

RenameAttachmentFluentHelper(String servicePath, String documentInfoRecordDocType, String documentInfoRecordDocVersion, String logicalDocument, String archiveDocumentID, String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject, String fileName, String documentInfoRecordDocNumber, String documentInfoRecordDocPart) Creates a fluent helper object that will execute the RenameAttachment OData function import with the provided parameters.

Method Summary

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.
AttachmentContent	execute(HttpDestinationProperties destination)
protected Class<AttachmentContent>	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.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction

executeMultiple, executeSingle, getJsonResponseObjectName

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

cachingMetadata, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenameAttachmentFluentHelper

public RenameAttachmentFluentHelper(@Nonnull
                                    String servicePath,
                                    String documentInfoRecordDocType,
                                    String documentInfoRecordDocVersion,
                                    String logicalDocument,
                                    String archiveDocumentID,
                                    String businessObjectTypeName,
                                    String linkedSAPObjectKey,
                                    String semanticObject,
                                    String fileName,
                                    String documentInfoRecordDocNumber,
                                    String documentInfoRecordDocPart)

Creates a fluent helper object that will execute the RenameAttachment OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Parameters:

documentInfoRecordDocType - DocumentInfoRecordDocType

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: DocumentInfoRecordDocType

fileName - FileName

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: FileName

documentInfoRecordDocNumber - DocumentInfoRecordDocNumber

Constraints: Nullable, Maximum length: 25

Original parameter name from the Odata EDM: DocumentInfoRecordDocNumber

documentInfoRecordDocPart - DocumentInfoRecordDocPart

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: DocumentInfoRecordDocPart

servicePath - Service path to be used to call the functions against.

archiveDocumentID - ArchiveDocumentID

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: ArchiveDocumentID

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

documentInfoRecordDocVersion - DocumentInfoRecordDocVersion

Constraints: Nullable, Maximum length: 2

Original parameter name from the Odata EDM: DocumentInfoRecordDocVersion

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

logicalDocument - LogicalDocument

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: LogicalDocument

Method Detail

getEntityClass

@Nonnull
protected Class<AttachmentContent> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Returns:

A class object of the handled type.

getFunctionName

@Nonnull
protected String getFunctionName()

Description copied from class: FluentHelperFunction

The exact name of the function to be called on the OData Endpoint.

Specified by:

getFunctionName in class FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Returns:

The function name on the endpoint.

refineJsonResponse

@Nullable
protected com.google.gson.JsonElement refineJsonResponse(@Nullable
                                                                   com.google.gson.JsonElement jsonElement)

Description copied from class: FluentHelperFunction

Transform the JSON element from the response to extract a result entity. By default this method returns the original object.

Overrides:

refineJsonResponse in class FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Parameters:

jsonElement - The optional response JSON element

Returns:

The refined JSON element

getParameters

@Nonnull
protected Map<String,Object> getParameters()

Description copied from class: FluentHelperFunction

Getter for the map of parameters to be used in the function call.

The map maps the ODataName of a parameter to the corresponding value.

Specified by:

getParameters in class FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Returns:

A map containing the parameter for the function call.

createRequest

@Nonnull
protected org.apache.http.client.methods.HttpUriRequest createRequest(@Nonnull
                                                                               URI uri)

Description copied from class: FluentHelperFunction

Creates a request for this function based on the given URI.

Examples for such requests are HttpGet and HttpPost.

Specified by:

createRequest in class FluentHelperFunction<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Nullable
public AttachmentContent execute(@Nonnull
                                           HttpDestinationProperties destination)
                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Specified by:

execute in class FluentHelperBasic<RenameAttachmentFluentHelper,AttachmentContent,AttachmentContent>

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException