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(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultAttachmentService")
public class DefaultAttachmentService
extends Object
implements AttachmentService

With this service, you can read, create, rename, and delete attachments.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CV_ATTACHMENT_SRV
API Version:	1
Communication Scenario:	Distributed Manufacturing Integration (SAP_COM_0077), Product Lifecycle Management - Master Data Integration (SAP_COM_0105)
Scope Items:	3D Printing On-Demand-Manufacturing Collaboration on HCP (1NX), Change Record based Product Data Management (1NF), Engineering Bill of Material Versions Management (1NR), Engineering Bill of Material Change Master Management (1R3)

Constructor Summary

Constructors

Constructor and Description
DefaultAttachmentService()

Method Summary

Modifier and Type	Method and Description
AttachmentContentCreateFluentHelper	createAttachmentContent(AttachmentContent attachmentContent) Create a new AttachmentContent 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 attachmentCreates a fluent helper for the CreateUrlAsAttachment OData function import.
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 ObjectCreates a fluent helper for the GetAllOriginals OData function import.
GetAttachmentCountFluentHelper	getAttachmentCount(String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject) Returns the Count of AttachmentsCreates a fluent helper for the GetAttachmentCount OData function import.
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 AttachmentCreates a fluent helper for the RenameAttachment OData function import.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.

getAllDocumentInfoRecordAttch

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

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.

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

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

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

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.