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

Interface DocumentManagementService

All Known Implementing Classes:

DefaultDocumentManagementService

public interface DocumentManagementService

This service enables you to create, read, update the Document Info Records(DIR) along with object Links.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_DMS_PROCESS_SRV
API Version:	1
Communication Scenario:	Product Lifecycle Management - Master Data Integration (SAP_COM_0105)
Scope Items:	Change Record based Product Data Management (1NF)

Method Summary

Modifier and Type	Method and Description
DocInfoRecdObjLinkProductCreateFluentHelper	createDocInfoRecdObjLinkProduct(DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct) Create a new DocInfoRecdObjLinkProduct entity and save it to the S/4HANA system.
DocumentInfoRecordCreateFluentHelper	createDocumentInfoRecord(DocumentInfoRecord documentInfoRecord) Create a new DocumentInfoRecord entity and save it to the S/4HANA system.
DocumentInfoRecordDescCreateFluentHelper	createDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc) Create a new DocumentInfoRecordDesc entity and save it to the S/4HANA system.
DocInfoRecdObjLinkProductDeleteFluentHelper	deleteDocInfoRecdObjLinkProduct(DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct) Deletes an existing DocInfoRecdObjLinkProduct entity in the S/4HANA system.
DocumentInfoRecordDescDeleteFluentHelper	deleteDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc) Deletes an existing DocumentInfoRecordDesc entity in the S/4HANA system.
DocInfoRecdObjLinkProductFluentHelper	getAllDocInfoRecdObjLinkProduct() Fetch multiple DocInfoRecdObjLinkProduct entities.
DocumentInfoRecordFluentHelper	getAllDocumentInfoRecord() Fetch multiple DocumentInfoRecord entities.
DocumentInfoRecordDescFluentHelper	getAllDocumentInfoRecordDesc() Fetch multiple DocumentInfoRecordDesc entities.
DocumentInfoRecordDocStsVHFluentHelper	getAllDocumentInfoRecordDocStsVH() Fetch multiple DocumentInfoRecordDocStsVH entities.
DocInfoRecdObjLinkProductByKeyFluentHelper	getDocInfoRecdObjLinkProductByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter) Fetch a single DocInfoRecdObjLinkProduct entity using key fields.
DocumentInfoRecordByKeyFluentHelper	getDocumentInfoRecordByKey(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String documentInfoRecordDocNumber, String documentInfoRecordDocPart) Fetch a single DocumentInfoRecord entity using key fields.
DocumentInfoRecordDescByKeyFluentHelper	getDocumentInfoRecordDescByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String language) Fetch a single DocumentInfoRecordDesc entity using key fields.
DocumentInfoRecordDocStsVHByKeyFluentHelper	getDocumentInfoRecordDocStsVHByKey(String documentInfoRecordDocType, String language, String externalDocumentStatus) Fetch a single DocumentInfoRecordDocStsVH entity using key fields.
DocumentInfoRecordUpdateFluentHelper	updateDocumentInfoRecord(DocumentInfoRecord documentInfoRecord) Update an existing DocumentInfoRecord entity and save it to the S/4HANA system.
DocumentInfoRecordDescUpdateFluentHelper	updateDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc) Update an existing DocumentInfoRecordDesc entity and save it to the S/4HANA system.

Method Detail

getAllDocInfoRecdObjLinkProduct

DocInfoRecdObjLinkProductFluentHelper getAllDocInfoRecdObjLinkProduct()

Fetch multiple DocInfoRecdObjLinkProduct entities.

Returns:

A fluent helper to fetch multiple DocInfoRecdObjLinkProduct 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.

getDocInfoRecdObjLinkProductByKey

DocInfoRecdObjLinkProductByKeyFluentHelper getDocInfoRecdObjLinkProductByKey(String documentInfoRecordDocType,
                                                                             String documentInfoRecordDocNumber,
                                                                             String documentInfoRecordDocVersion,
                                                                             String documentInfoRecordDocPart,
                                                                             String linkedSAPObject,
                                                                             String linkedSAPObjectKey,
                                                                             String docObjectLinkCounter)

Fetch a single DocInfoRecdObjLinkProduct entity using key fields.

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

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

Constraints: Not nullable, Maximum length: 3

linkedSAPObjectKey - Number which identifies the master record of an object that is allocated to a document.

Constraints: Not nullable, Maximum length: 90

docObjectLinkCounter - Counter key

Constraints: Not nullable, Maximum length: 4

documentInfoRecordDocVersion - Number which identifies the version of a document.

Constraints: Not nullable, Maximum length: 2

linkedSAPObject - Database table of the master record that is linked to the document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single DocInfoRecdObjLinkProduct 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.

createDocInfoRecdObjLinkProduct

DocInfoRecdObjLinkProductCreateFluentHelper createDocInfoRecdObjLinkProduct(DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)

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

Parameters:

docInfoRecdObjLinkProduct - DocInfoRecdObjLinkProduct entity object that will be created in the S/4HANA system.

Returns:

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

deleteDocInfoRecdObjLinkProduct

DocInfoRecdObjLinkProductDeleteFluentHelper deleteDocInfoRecdObjLinkProduct(DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)

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

Parameters:

docInfoRecdObjLinkProduct - DocInfoRecdObjLinkProduct entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllDocumentInfoRecord

DocumentInfoRecordFluentHelper getAllDocumentInfoRecord()

Fetch multiple DocumentInfoRecord entities.

Returns:

A fluent helper to fetch multiple DocumentInfoRecord 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.

getDocumentInfoRecordByKey

DocumentInfoRecordByKeyFluentHelper getDocumentInfoRecordByKey(String documentInfoRecordDocType,
                                                               String documentInfoRecordDocVersion,
                                                               String documentInfoRecordDocNumber,
                                                               String documentInfoRecordDocPart)

Fetch a single DocumentInfoRecord entity using key fields.

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

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

Constraints: Not nullable, Maximum length: 3

documentInfoRecordDocVersion - Number which identifies the version of a document.

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single DocumentInfoRecord 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.

createDocumentInfoRecord

DocumentInfoRecordCreateFluentHelper createDocumentInfoRecord(DocumentInfoRecord documentInfoRecord)

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

Parameters:

documentInfoRecord - DocumentInfoRecord entity object that will be created in the S/4HANA system.

Returns:

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

updateDocumentInfoRecord

DocumentInfoRecordUpdateFluentHelper updateDocumentInfoRecord(DocumentInfoRecord documentInfoRecord)

Update an existing DocumentInfoRecord entity and save it to the S/4HANA system.

Parameters:

documentInfoRecord - DocumentInfoRecord entity object that will be updated in the S/4HANA system.

Returns:

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

getAllDocumentInfoRecordDesc

DocumentInfoRecordDescFluentHelper getAllDocumentInfoRecordDesc()

Fetch multiple DocumentInfoRecordDesc entities.

Returns:

A fluent helper to fetch multiple DocumentInfoRecordDesc 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.

getDocumentInfoRecordDescByKey

DocumentInfoRecordDescByKeyFluentHelper getDocumentInfoRecordDescByKey(String documentInfoRecordDocType,
                                                                       String documentInfoRecordDocNumber,
                                                                       String documentInfoRecordDocVersion,
                                                                       String documentInfoRecordDocPart,
                                                                       String language)

Fetch a single DocumentInfoRecordDesc entity using key fields.

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

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

Constraints: Not nullable, Maximum length: 3

documentInfoRecordDocVersion - Number which identifies the version of a document.

Constraints: Not nullable, Maximum length: 2

language - Key for the language in which you want to maintain the text.

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single DocumentInfoRecordDesc 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.

createDocumentInfoRecordDesc

DocumentInfoRecordDescCreateFluentHelper createDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc)

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

Parameters:

documentInfoRecordDesc - DocumentInfoRecordDesc entity object that will be created in the S/4HANA system.

Returns:

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

updateDocumentInfoRecordDesc

DocumentInfoRecordDescUpdateFluentHelper updateDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc)

Update an existing DocumentInfoRecordDesc entity and save it to the S/4HANA system.

Parameters:

documentInfoRecordDesc - DocumentInfoRecordDesc entity object that will be updated in the S/4HANA system.

Returns:

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

deleteDocumentInfoRecordDesc

DocumentInfoRecordDescDeleteFluentHelper deleteDocumentInfoRecordDesc(DocumentInfoRecordDesc documentInfoRecordDesc)

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

Parameters:

documentInfoRecordDesc - DocumentInfoRecordDesc entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllDocumentInfoRecordDocStsVH

DocumentInfoRecordDocStsVHFluentHelper getAllDocumentInfoRecordDocStsVH()

Fetch multiple DocumentInfoRecordDocStsVH entities.

Returns:

A fluent helper to fetch multiple DocumentInfoRecordDocStsVH 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.

getDocumentInfoRecordDocStsVHByKey

DocumentInfoRecordDocStsVHByKeyFluentHelper getDocumentInfoRecordDocStsVHByKey(String documentInfoRecordDocType,
                                                                               String language,
                                                                               String externalDocumentStatus)

Fetch a single DocumentInfoRecordDocStsVH entity using key fields.

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

externalDocumentStatus - This key shows the document status.

Constraints: Not nullable, Maximum length: 2

language - Key for the language in which you want to maintain the text.

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single DocumentInfoRecordDocStsVH 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.