Package com.technia.dsx.threedspace.doc

Interface DocumentService

public interface DocumentService
Service for managing documents in the 3DEXPERIENCE platform.

Provides operations to search, create, update, delete, reserve, unreserve, and manage files for documents. Also provides access to FCS (File Content Service) and FileService for file operations.

  • Method Details

    • getFCSService

      FCSService getFCSService()
      Returns:
      The FCSService that is used when obtaining tickets for checkin/checkout operations of the physical files.

    • getFileService

      FileService getFileService()
      Returns:
      The FileService that allows performing the actual file operations

    • search

      @Remote(READ) DocumentSearchResult search(com.technia.dsx.common.TenantSession session, String searchString, Integer maxResult, Integer skip, Resources.Includes includes, Resources.Fields fields)
      Performs a search for Documents
      Parameters:
      session - The current session
      searchString - The search string,
      maxResult - The max nr of hits (null allowed, implies 10?)
      skip - Used for paginated results.
      includes - Identify sub-resources that should be returned by the web request.
      fields - Identify resource and sub-resource fields that should be returned by the web request.
      Returns:
      The result

    • create

      @Remote(CREATE) DocumentResult create(com.technia.dsx.common.TenantSession session, CreateUpdateDocumentsInput createInput, Resources.Includes includes, Resources.Fields fields)
      Creates one or more Documents.
      Parameters:
      session - The current session
      createInput - The input used to create the documents
      includes - Identify sub-resources that should be returned by the web request.
      fields - Identify resource and sub-resource fields that should be returned by the web request.
      Returns:
      The document create result

    • update

      @Remote(UPDATE) DocumentResult update(com.technia.dsx.common.TenantSession session, CreateUpdateDocumentsInput updateInput, Resources.Includes includes, Resources.Fields fields)
      Updates one or more Documents.
      Parameters:
      session - The current session
      updateInput - The input used to create the documents
      includes - Identify sub-resources that should be returned by the web request.
      fields - Identify resource and sub-resource fields that should be returned by the web request.
      Returns:
      The document update result

    • update

      @Remote(UPDATE) DocumentResult update(com.technia.dsx.common.TenantSession session, String documentId, CreateUpdateDocumentsInput updateInput, Resources.Includes includes, Resources.Fields fields)

    • getDocument

      @Remote(READ) DocumentResult getDocument(com.technia.dsx.common.TenantSession session, String docId, Resources.Includes includes, Resources.Fields fields)
      Parameters:
      session -
      docId -
      includes -
      fields -
      Returns:

    • getDocuments

      @Remote(READ) DocumentResult getDocuments(com.technia.dsx.common.TenantSession session, List<String> docIds, Resources.Includes includes, Resources.Fields fields)

    • delete

      @Remote(DELETE) DeleteResult delete(com.technia.dsx.common.TenantSession session, String docId)
      Deletes a document
      Parameters:
      session -
      docId -
      Returns:

    • reserve

      @Remote(UPDATE) DocumentResult reserve(com.technia.dsx.common.TenantSession session, String docId, Resources.Includes includes, Resources.Fields fields)
      Reserves the given document
      Parameters:
      session -
      docId -
      includes -
      fields -
      Returns:

    • unreserve

      @Remote(UPDATE) DocumentResult unreserve(com.technia.dsx.common.TenantSession session, String docId, Resources.Includes includes, Resources.Fields fields)
      Unreserves the given document
      Parameters:
      session -
      docId -
      includes -
      fields -
      Returns:

    • getParentDocuments

      @Remote(READ) DocumentResult getParentDocuments(com.technia.dsx.common.TenantSession session, String parentId, String relationship, Direction direction, Resources.Includes includes, Resources.Fields fields)
      Get the documents related to a given parent object.
      Parameters:
      session -
      parentId -
      relationship -
      direction -
      includes -
      fields -
      Returns:

    • getFiles

      @Remote(READ) FileResult getFiles(com.technia.dsx.common.TenantSession session, String documentId, Resources.Includes includes, Resources.Fields fields)
      Get files for a given document
      Parameters:
      session -
      documentId -
      includes -
      fields -
      Returns:

    • getFileVersions

      @Remote(READ) FileVersionResult getFileVersions(com.technia.dsx.common.TenantSession session, String documentId, String fileId, Resources.Includes includes, Resources.Fields fields)
      Get the version information of one particular file.
      Parameters:
      session -
      documentId -
      fileId -
      includes -
      fields -
      Returns:

    • deleteFile

      @Remote(DELETE) DeleteResult deleteFile(com.technia.dsx.common.TenantSession session, String documentId, String fileId)
      Parameters:
      session -
      documentId -
      fileId -
      Returns:

    • deleteFileVersion

      @Remote(DELETE) DeleteResult deleteFileVersion(com.technia.dsx.common.TenantSession session, String documentId, String fileId, String fileVersionId)
      Parameters:
      session -
      documentId -
      fileId -
      fileVersionId -
      Returns:

    • updateFiles

      @Remote(UPDATE) FileResult updateFiles(com.technia.dsx.common.TenantSession session, String documentId, CreateUpdateFilesInput input, Resources.Includes includes, Resources.Fields fields)
      Update the document object files.
      Parameters:
      session -
      documentId -
      input -
      includes -
      fields -
      Returns:

    • createFiles

      @Remote(CREATE) FileResult createFiles(com.technia.dsx.common.TenantSession session, String documentId, CreateUpdateFilesInput input, Resources.Includes includes, Resources.Fields fields)
      Create new document object files.
      Parameters:
      session -
      documentId -
      input -
      includes -
      fields -
      Returns:

    • updateDocumentFiles

      @Remote(UPDATE) FileResult updateDocumentFiles(com.technia.dsx.common.TenantSession session, String documentId, String fileId, CreateUpdateFilesInput input, Resources.Includes includes, Resources.Fields fields)