Package org.exoplatform.documents.storage

Interface JCRDeleteFileStorage

public interface JCRDeleteFileStorage

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    countDeletedDocuments()
    Counts the total number of deleted documents in the trash.
    void
    deleteDocument(String documentPath, String documentId, boolean favorite, boolean checkToMoveToTrash, long delay, org.exoplatform.services.security.Identity acIdentity, long userIdentityId)
    Delete document (Move to trash)
    void
    deleteDocument(javax.jcr.Session session, String folderPath, String documentId, boolean favorite, boolean checkToMoveToTrash, long delay, org.exoplatform.services.security.Identity identity, long userIdentityId)
    Delete document (Move to trash)
    void
    deleteDocumentPermanently(String trashNodePath)
    Delete a document from the trash based on the specified trash node path.
    void
    deleteDocuments(int actionId, List<AbstractNode> items, org.exoplatform.services.security.Identity identity, long authenticatedUserId)
    Delete a list of document (Move to trash)
    List<TrashElementNode>
    getDeletedDocuments(TrashElementNodeFilter trashElementNodeFilter)
    Retrieves a list of trash elements that match the specified filter.
    Map<String,String>
    getDocumentsToDelete()
     
    void
    restoreFromTrash(String trashNodePath)
    Restores a document from the trash based on the specified trash node path.
    void
    undoDelete(String documentId, long userIdentityId)
    Undo delete document

  • Method Details

    • getDocumentsToDelete

      Map<String,String> getDocumentsToDelete()

    • deleteDocument

      void deleteDocument(String documentPath, String documentId, boolean favorite, boolean checkToMoveToTrash, long delay, org.exoplatform.services.security.Identity acIdentity, long userIdentityId)
      Delete document (Move to trash)
      Parameters:
      documentPath -
      documentId -
      favorite -
      checkToMoveToTrash -
      delay -
      acIdentity -
      userIdentityId -

    • undoDelete

      void undoDelete(String documentId, long userIdentityId)
      Undo delete document
      Parameters:
      documentId -
      userIdentityId -

    • deleteDocument

      void deleteDocument(javax.jcr.Session session, String folderPath, String documentId, boolean favorite, boolean checkToMoveToTrash, long delay, org.exoplatform.services.security.Identity identity, long userIdentityId) throws org.exoplatform.commons.exception.ObjectNotFoundException, javax.jcr.RepositoryException
      Delete document (Move to trash)
      Parameters:
      session - current session
      folderPath - folder path
      documentId - document id
      favorite - favorite or not
      checkToMoveToTrash - check whether to move to trash
      delay - waiting delay
      identity - user identity
      userIdentityId - user identity id
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException
      javax.jcr.RepositoryException

    • deleteDocuments

      void deleteDocuments(int actionId, List<AbstractNode> items, org.exoplatform.services.security.Identity identity, long authenticatedUserId)
      Delete a list of document (Move to trash)
      Parameters:
      actionId - action id
      items - list of items to delete
      identity - user identity
      authenticatedUserId - current authenticated user id

    • getDeletedDocuments

      List<TrashElementNode> getDeletedDocuments(TrashElementNodeFilter trashElementNodeFilter) throws javax.jcr.RepositoryException
      Retrieves a list of trash elements that match the specified filter.
      Parameters:
      trashElementNodeFilter - the filter used to find trash elements
      Returns:
      a list of nodes representing the trash elements
      Throws:
      javax.jcr.RepositoryException - if an error occurs while accessing the repository

    • countDeletedDocuments

      int countDeletedDocuments()
      Counts the total number of deleted documents in the trash.
      Returns:
      the total count of deleted documents

    • restoreFromTrash

      void restoreFromTrash(String trashNodePath) throws javax.jcr.RepositoryException
      Restores a document from the trash based on the specified trash node path.
      Parameters:
      trashNodePath - the path of the trash node to restore
      Throws:
      javax.jcr.RepositoryException - if an error occurs during the restoration process

    • deleteDocumentPermanently

      void deleteDocumentPermanently(String trashNodePath) throws org.exoplatform.commons.exception.ObjectNotFoundException, javax.jcr.RepositoryException
      Delete a document from the trash based on the specified trash node path.
      Parameters:
      trashNodePath - the path of the trash node to delete
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException - if a document not exist in the trash
      javax.jcr.RepositoryException - if an error occurs during the delete process