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:

BatchService<AttachmentServiceBatch>, AttachmentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultAttachmentService")
public class DefaultAttachmentService
extends Object
implements AttachmentService

This service enables you to manage Document Management (DMS), and Generic Object Services (GOS) based attachments, such as creating, reading, renaming, and deleting attachments. You can also read an existing document info record (DIR), and add attachments to it..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CV_ATTACHMENT_SRV
API Version:	1
Communication Scenario:	Purchase Requisition Integration (SAP_COM_0102), Distributed Manufacturing Integration (SAP_COM_0077), Product Lifecycle Management - Master Data Integration (SAP_COM_0105), Supplier Invoice Integration (SAP_COM_0057), Defect Processing Integration (SAP_COM_0153), Finance - Posting Integration (SAP_COM_0002), SAP S/4HANA Procurement Hub - Ariba GB - Hub to Ariba GB Integration (SAP_COM_0292), Legal Document Integration (SAP_COM_0178)
Scope Items:	Requisitioning (18J), Procure-to-Pay with SAP Ariba Buying and Invoicing (1ZM), Guided Buying Capability with SAP Ariba Buying (2NV), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45), Physical Inventory - Inventory Count and Adjustment (OML), Collaborative Manufacturing with SAP Digital Manufacturing Cloud (1NX), Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3), Procurement of Direct Materials (O45), Quality Management in Discrete Manufacturing (1E1), Quality Management in Procurement (1FM), Quality Management in Sales (1MP), Quality Management in Stock Handling (1MR), Nonconformance Management (2QN), Accounting and Financial Close (J58), Accounting and Financial Close (O58), SAP S/4HANA for Enterprise Contract Management (1XV)
Authentication Methods:	Basic, x509

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.AttachmentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultAttachmentService() Creates a service using AttachmentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultAttachmentServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
AttachmentContentCreateFluentHelper	createAttachmentContent(AttachmentContent attachmentContent) Create a new AttachmentContent entity and save it to the S/4HANA system.
DocumentInfoRecordAttchCreateFluentHelper	createDocumentInfoRecordAttch(DocumentInfoRecordAttch documentInfoRecordAttch) Create a new DocumentInfoRecordAttch entity and save it to the S/4HANA system.
CreateUrlAsAttachmentFluentHelper	createUrlAsAttachment(String semanticObject, String linkedSAPObjectKey, String businessObjectTypeName, String url, String urlDescription, String mIMEType) Create URL as attachment
AttachmentContentDeleteFluentHelper	deleteAttachmentContent(AttachmentContent attachmentContent) Deletes an existing AttachmentContent entity in the S/4HANA system.
DocumentInfoRecordAttchFluentHelper	getAllDocumentInfoRecordAttch() Fetch multiple DocumentInfoRecordAttch entities.
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
DocumentInfoRecordAttchByKeyFluentHelper	getDocumentInfoRecordAttchByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart) Fetch a single DocumentInfoRecordAttch entity using key fields.
RenameAttachmentFluentHelper	renameAttachment(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String logicalDocument, String archiveDocumentID, String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject, String fileName, String documentInfoRecordDocNumber, String documentInfoRecordDocPart) Rename Attachment
DefaultAttachmentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAttachmentService

public DefaultAttachmentService()

Creates a service using AttachmentService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultAttachmentService withServicePath(@Nonnull
                                                         String servicePath)

Description copied from interface: AttachmentService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface AttachmentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultAttachmentServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<AttachmentServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

createAttachmentContent

@Nonnull
public AttachmentContentCreateFluentHelper createAttachmentContent(@Nonnull
                                                                            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

@Nonnull
public AttachmentContentDeleteFluentHelper deleteAttachmentContent(@Nonnull
                                                                            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.

getAllDocumentInfoRecordAttch

@Nonnull
public DocumentInfoRecordAttchFluentHelper getAllDocumentInfoRecordAttch()

Description copied from interface: AttachmentService

Fetch multiple DocumentInfoRecordAttch entities.

Specified by:

getAllDocumentInfoRecordAttch in interface AttachmentService

Returns:

A fluent helper to fetch multiple DocumentInfoRecordAttch entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getDocumentInfoRecordAttchByKey

@Nonnull
public DocumentInfoRecordAttchByKeyFluentHelper getDocumentInfoRecordAttchByKey(String documentInfoRecordDocType,
                                                                                         String documentInfoRecordDocNumber,
                                                                                         String documentInfoRecordDocVersion,
                                                                                         String documentInfoRecordDocPart)

Description copied from interface: AttachmentService

Fetch a single DocumentInfoRecordAttch entity using key fields.

Specified by:

getDocumentInfoRecordAttchByKey in interface AttachmentService

Parameters:

documentInfoRecordDocType - Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them.

Constraints: Not nullable, Maximum length: 3

documentInfoRecordDocNumber - This number is the main part of the document key, which is used to identify the document.

Constraints: Not nullable, Maximum length: 25

documentInfoRecordDocVersion - Number which identifies the version of a document.

Constraints: Not nullable, Maximum length: 2

documentInfoRecordDocPart - Section of a document which is maintained as an independent document.

Constraints: Not nullable, Maximum length: 3

Returns:

A fluent helper to fetch a single DocumentInfoRecordAttch entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

createDocumentInfoRecordAttch

@Nonnull
public DocumentInfoRecordAttchCreateFluentHelper createDocumentInfoRecordAttch(@Nonnull
                                                                                        DocumentInfoRecordAttch documentInfoRecordAttch)

Description copied from interface: AttachmentService

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

Specified by:

createDocumentInfoRecordAttch in interface AttachmentService

Parameters:

documentInfoRecordAttch - DocumentInfoRecordAttch entity object that will be created in the S/4HANA system.

Returns:

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

getAllOriginals

@Nonnull
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 - 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

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

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

@Nonnull
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 - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

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

@Nonnull
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 - DocumentInfoRecordDocType

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: DocumentInfoRecordDocType

documentInfoRecordDocVersion - DocumentInfoRecordDocVersion

Constraints: Nullable, Maximum length: 2

Original parameter name from the Odata EDM: DocumentInfoRecordDocVersion

logicalDocument - LogicalDocument

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: LogicalDocument

archiveDocumentID - ArchiveDocumentID

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: ArchiveDocumentID

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

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

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.

createUrlAsAttachment

@Nonnull
public CreateUrlAsAttachmentFluentHelper createUrlAsAttachment(String semanticObject,
                                                                        String linkedSAPObjectKey,
                                                                        String businessObjectTypeName,
                                                                        String url,
                                                                        String urlDescription,
                                                                        String mIMEType)

Description copied from interface: AttachmentService

Create URL as attachment

Creates a fluent helper for the CreateUrlAsAttachment OData function import.

Specified by:

createUrlAsAttachment in interface AttachmentService

Parameters:

semanticObject - SemanticObject

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

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

url - Url

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: Url

urlDescription - UrlDescription

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: UrlDescription

mIMEType - MIMEType

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: MIMEType

Returns:

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