com.sap.cloud.sdk.s4hana.datamodel.odata.services

Class DefaultAttachmentService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultAttachmentService

All Implemented Interfaces:

AttachmentService

@Named
public class DefaultAttachmentService
extends Object
implements AttachmentService

This service enables you to manage the entire life cycle of a DMS based attachment: from attachment creation to attachment storage, from access to update via OData Service.

Reference: SAP API Business Hub

Details:

OData Service:	API_CV_ATTACHMENT_SRV
API Version:	1
Communication Scenario:	Product Lifecycle Management - Master Data Integration (SAP_COM_0105)
Scope Items:	Engineering Bill of Material - Versions Management (1NR)

Constructor Summary

Constructors

Constructor and Description
DefaultAttachmentService()

Method Summary

Methods

Modifier and Type	Method and Description
AttachmentContentCreateFluentHelper	createAttachmentContent(AttachmentContent attachmentContent) Create a new AttachmentContent entity and save it to the S/4HANA system.
AttachmentContentDeleteFluentHelper	deleteAttachmentContent(AttachmentContent attachmentContent) Deletes an existing AttachmentContent entity in the S/4HANA system.
GetAllOriginalsFluentHelper	getAllOriginals(String linkedSAPObjectKey, String businessObjectTypeName, String semanticObject) Returns All Originals Related to a Parent Object
GetAttachmentCountFluentHelper	getAttachmentCount(String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject) Returns the Count of Attachments
RenameAttachmentFluentHelper	renameAttachment(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String logicalDocument, String archiveDocumentID, String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject, String fileName, String documentInfoRecordDocNumber, String documentInfoRecordDocPart) Rename Attachment

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAttachmentService

public DefaultAttachmentService()

Method Detail

createAttachmentContent

public AttachmentContentCreateFluentHelper createAttachmentContent(AttachmentContent attachmentContent)

Description copied from interface: AttachmentService

Create a new AttachmentContent entity and save it to the S/4HANA system.

Specified by:

createAttachmentContent in interface AttachmentService

Parameters:

attachmentContent - AttachmentContent entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new AttachmentContent entity. To perform execution, call the execute method on the fluent helper object.

deleteAttachmentContent

public AttachmentContentDeleteFluentHelper deleteAttachmentContent(AttachmentContent attachmentContent)

Description copied from interface: AttachmentService

Deletes an existing AttachmentContent entity in the S/4HANA system.

Specified by:

deleteAttachmentContent in interface AttachmentService

Parameters:

attachmentContent - AttachmentContent entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing AttachmentContent entity. To perform execution, call the execute method on the fluent helper object.

getAllOriginals

public GetAllOriginalsFluentHelper getAllOriginals(String linkedSAPObjectKey,
                                          String businessObjectTypeName,
                                          String semanticObject)

Description copied from interface: AttachmentService

Returns All Originals Related to a Parent Object

Creates a fluent helper for the GetAllOriginals OData function import.

Specified by:

getAllOriginals in interface AttachmentService

Parameters:

linkedSAPObjectKey - Constraints: Not nullable, Maximum length: 90

businessObjectTypeName - Constraints: Not nullable, Maximum length: 40

semanticObject - Constraints: Nullable, Maximum length: 40

Returns:

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

getAttachmentCount

public GetAttachmentCountFluentHelper getAttachmentCount(String businessObjectTypeName,
                                                String linkedSAPObjectKey,
                                                String semanticObject)

Description copied from interface: AttachmentService

Returns the Count of Attachments

Creates a fluent helper for the GetAttachmentCount OData function import.

Specified by:

getAttachmentCount in interface AttachmentService

Parameters:

businessObjectTypeName - Constraints: Not nullable, Maximum length: 40

linkedSAPObjectKey - Constraints: Not nullable, Maximum length: 90

semanticObject - Constraints: Nullable, Maximum length: 40

Returns:

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

renameAttachment

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

Description copied from interface: AttachmentService

Rename Attachment

Creates a fluent helper for the RenameAttachment OData function import.

Specified by:

renameAttachment in interface AttachmentService

Parameters:

documentInfoRecordDocType - Constraints: Nullable, Maximum length: 3

documentInfoRecordDocVersion - Constraints: Nullable, Maximum length: 2

logicalDocument - Constraints: Not nullable, Maximum length: 32

archiveDocumentID - Constraints: Not nullable, Maximum length: 40

businessObjectTypeName - Constraints: Not nullable, Maximum length: 40

linkedSAPObjectKey - Constraints: Not nullable, Maximum length: 90

semanticObject - Constraints: Nullable, Maximum length: 40

fileName - Constraints: Not nullable, Maximum length: 255

documentInfoRecordDocNumber - Constraints: Nullable, Maximum length: 25

documentInfoRecordDocPart - Constraints: Nullable, Maximum length: 3

Returns:

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.