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

Interface DocumentManagementService

All Superinterfaces:
BatchService<DocumentManagementServiceBatch>
All Known Implementing Classes:
DefaultDocumentManagementService
@Deprecated public interface DocumentManagementService extends BatchService<DocumentManagementServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains header data of the document info record (DIR), description, object link information for BOM, product, and change record, classification details for class and characteristics, and value help for document status as nodes. All the information can be sent as part of the request payload, which is then used to maintain the DIR, including appropriate checks for restricted values and authorizations. The data associated to the document info record is sent in the response. If there are any issues in the request such as wrong values or insufficient information, the system displays error messages in the response. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_DMS_PROCESS_SRV
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Product Lifecycle Management - Master Data Integration(SAP_COM_0105)
Scope Items: Make-to-Order Production - Finished Goods Sales and Final Assembly(BJE), Engineering Bill of Material - Versions Management(1NR), Engineering Bill of Material - Change Master Management(1R3), Change Manufacturing Bill of Material for Production(3LO), Mass Change Manufacturing Bill of Material for Production(3LP)
Authentication Methods: x509
Business Object: Document Info Record

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull DocumentManagementService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • getAllDocInfoRecdObjLinkBOM

      @Nonnull DocInfoRecdObjLinkBOMFluentHelper getAllDocInfoRecdObjLinkBOM()
      Deprecated.
      Fetch multiple DocInfoRecdObjLinkBOM entities.
      Returns:
      A fluent helper to fetch multiple DocInfoRecdObjLinkBOM 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.

    • getDocInfoRecdObjLinkBOMByKey

      @Nonnull DocInfoRecdObjLinkBOMByKeyFluentHelper getDocInfoRecdObjLinkBOMByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
      Deprecated.
      Fetch a single DocInfoRecdObjLinkBOM entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      linkedSAPObjectKey - Document Management Object Key

      Constraints: Not nullable, Maximum length: 90

      docObjectLinkCounter - Counter key

      Constraints: Not nullable, Maximum length: 4

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      linkedSAPObject - Linked SAP Object

      Constraints: Not nullable, Maximum length: 10

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

    • getAllDocInfoRecdObjLinkChgRecd

      @Nonnull DocInfoRecdObjLinkChgRecdFluentHelper getAllDocInfoRecdObjLinkChgRecd()
      Deprecated.
      Fetch multiple DocInfoRecdObjLinkChgRecd entities.
      Returns:
      A fluent helper to fetch multiple DocInfoRecdObjLinkChgRecd 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.

    • getDocInfoRecdObjLinkChgRecdByKey

      @Nonnull DocInfoRecdObjLinkChgRecdByKeyFluentHelper getDocInfoRecdObjLinkChgRecdByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
      Deprecated.
      Fetch a single DocInfoRecdObjLinkChgRecd entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      linkedSAPObjectKey - Document Management Object Key

      Constraints: Not nullable, Maximum length: 90

      docObjectLinkCounter - Counter key

      Constraints: Not nullable, Maximum length: 4

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      linkedSAPObject - Linked SAP Object

      Constraints: Not nullable, Maximum length: 10

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

    • getAllDocInfoRecdObjLinkProduct

      @Nonnull DocInfoRecdObjLinkProductFluentHelper getAllDocInfoRecdObjLinkProduct()
      Deprecated.
      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

      @Nonnull DocInfoRecdObjLinkProductByKeyFluentHelper getDocInfoRecdObjLinkProductByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
      Deprecated.
      Fetch a single DocInfoRecdObjLinkProduct entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      linkedSAPObjectKey - Document Management Object Key

      Constraints: Not nullable, Maximum length: 90

      docObjectLinkCounter - Counter key

      Constraints: Not nullable, Maximum length: 4

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      linkedSAPObject - Linked SAP Object

      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

      @Nonnull DocInfoRecdObjLinkProductCreateFluentHelper createDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
      Deprecated.
      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

      @Nonnull DocInfoRecdObjLinkProductDeleteFluentHelper deleteDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
      Deprecated.
      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

      @Nonnull DocumentInfoRecordFluentHelper getAllDocumentInfoRecord()
      Deprecated.
      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

      @Nonnull DocumentInfoRecordByKeyFluentHelper getDocumentInfoRecordByKey(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String documentInfoRecordDocNumber, String documentInfoRecordDocPart)
      Deprecated.
      Fetch a single DocumentInfoRecord entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      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

      @Nonnull DocumentInfoRecordCreateFluentHelper createDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
      Deprecated.
      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

      @Nonnull DocumentInfoRecordUpdateFluentHelper updateDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
      Deprecated.
      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.

    • getAllDocumentInfoRecordCharc

      @Nonnull DocumentInfoRecordCharcFluentHelper getAllDocumentInfoRecordCharc()
      Deprecated.
      Fetch multiple DocumentInfoRecordCharc entities.
      Returns:
      A fluent helper to fetch multiple DocumentInfoRecordCharc 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.

    • getDocumentInfoRecordCharcByKey

      @Nonnull DocumentInfoRecordCharcByKeyFluentHelper getDocumentInfoRecordCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String charcInternalID, String classType)
      Deprecated.
      Fetch a single DocumentInfoRecordCharc entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      classType - Class Type

      Constraints: Not nullable, Maximum length: 3

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

    • getAllDocumentInfoRecordCharcValue

      @Nonnull DocumentInfoRecordCharcValueFluentHelper getAllDocumentInfoRecordCharcValue()
      Deprecated.
      Fetch multiple DocumentInfoRecordCharcValue entities.
      Returns:
      A fluent helper to fetch multiple DocumentInfoRecordCharcValue 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.

    • getDocumentInfoRecordCharcValueByKey

      @Nonnull DocumentInfoRecordCharcValueByKeyFluentHelper getDocumentInfoRecordCharcValueByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classType, String charcInternalID, String charcValuePositionNumber)
      Deprecated.
      Fetch a single DocumentInfoRecordCharcValue entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      charcValuePositionNumber - Characteristic value counter

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      classType - Class Type

      Constraints: Not nullable, Maximum length: 3

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

    • getAllDocumentInfoRecordClass

      @Nonnull DocumentInfoRecordClassFluentHelper getAllDocumentInfoRecordClass()
      Deprecated.
      Fetch multiple DocumentInfoRecordClass entities.
      Returns:
      A fluent helper to fetch multiple DocumentInfoRecordClass 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.

    • getDocumentInfoRecordClassByKey

      @Nonnull DocumentInfoRecordClassByKeyFluentHelper getDocumentInfoRecordClassByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID)
      Deprecated.
      Fetch a single DocumentInfoRecordClass entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      classInternalID - Internal Class Number

      Constraints: Not nullable, Maximum length: 10

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

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

    • getAllDocumentInfoRecordClassCharc

      @Nonnull DocumentInfoRecordClassCharcFluentHelper getAllDocumentInfoRecordClassCharc()
      Deprecated.
      Fetch multiple DocumentInfoRecordClassCharc entities.
      Returns:
      A fluent helper to fetch multiple DocumentInfoRecordClassCharc 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.

    • getDocumentInfoRecordClassCharcByKey

      @Nonnull DocumentInfoRecordClassCharcByKeyFluentHelper getDocumentInfoRecordClassCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID, String charcInternalID)
      Deprecated.
      Fetch a single DocumentInfoRecordClassCharc entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      classInternalID - Internal Class Number

      Constraints: Not nullable, Maximum length: 10

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

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

    • getAllDocumentInfoRecordDesc

      @Nonnull DocumentInfoRecordDescFluentHelper getAllDocumentInfoRecordDesc()
      Deprecated.
      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

      @Nonnull DocumentInfoRecordDescByKeyFluentHelper getDocumentInfoRecordDescByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String language)
      Deprecated.
      Fetch a single DocumentInfoRecordDesc entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocNumber - Document number

      Constraints: Not nullable, Maximum length: 25

      documentInfoRecordDocPart - Document Part

      Constraints: Not nullable, Maximum length: 3

      documentInfoRecordDocVersion - Document Version

      Constraints: Not nullable, Maximum length: 2

      language - Language

      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

      @Nonnull DocumentInfoRecordDescCreateFluentHelper createDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
      Deprecated.
      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

      @Nonnull DocumentInfoRecordDescUpdateFluentHelper updateDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
      Deprecated.
      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

      @Nonnull DocumentInfoRecordDescDeleteFluentHelper deleteDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
      Deprecated.
      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

      @Nonnull DocumentInfoRecordDocStsVHFluentHelper getAllDocumentInfoRecordDocStsVH()
      Deprecated.
      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

      @Nonnull DocumentInfoRecordDocStsVHByKeyFluentHelper getDocumentInfoRecordDocStsVHByKey(String documentInfoRecordDocType, String language, String externalDocumentStatus)
      Deprecated.
      Fetch a single DocumentInfoRecordDocStsVH entity using key fields.
      Parameters:
      documentInfoRecordDocType - Document Type

      Constraints: Not nullable, Maximum length: 3

      externalDocumentStatus - Status of a document (language-dependent)

      Constraints: Not nullable, Maximum length: 2

      language - Language

      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.