Package eu.xenit.alfred.api.filefolder

Interface IFileFolderService

public interface IFileFolderService
Service for operations related to files and folders.

  • Method Details

    • getDataDictionary

      NodeRef getDataDictionary()
      Get the data dictionary folder of the alfresco
      Returns:
      The noderef of the data dictionary folder

    • getPath

      NodePath getPath(NodeRef nodeRef)
      Parameters:
      nodeRef - The noderef of which the path is requested.
      Returns:
      The path (from the root node in alfresco) of the node.

    • getRootFolder

      NodeRef getRootFolder(StoreRef storeRef)
      Parameters:
      storeRef - The store of which the root folder is requested.
      Returns:
      The root folder of the storeRef.

    • getCompanyHome

      NodeRef getCompanyHome()
      Get the company home folder of the alfresco.
      Returns:
      The noderef of the company home folder.

    • existsFolder

      boolean existsFolder(NodeRef parent, String name)
      Checks if a folder exists.
      Parameters:
      parent - The parent in which the folder could be.
      name - The name of the folder.
      Returns:
      Whether a folder with the given name exists in the given parent folder.

    • getChildNodeRef

      NodeRef getChildNodeRef(NodeRef parent, String name)
      Get NodeRef of node with a given parent and a given name.
      Parameters:
      parent - The parent of the requested node.
      name - The name of the requested node.
      Returns:
      The NodeRef of node with a given parent and a given name.

    • getChildNodeRef

      NodeRef getChildNodeRef(NodeRef parent, String[] path)
      Get NodeRef of node with a given parent and a given relative path.
      Parameters:
      parent - The parent of the requested node.
      path - The path from the parent node to the requested node.
      Returns:
      The NodeRef of node with a given parent and a relative path from that parent node.

    • createFolder

      NodeRef createFolder(NodeRef parent, String folderName)
      Create a folder within a given parent node with a given name.
      Parameters:
      parent - The folder in which to create a new folder.
      folderName - The name of the new folder.
      Returns:
      The Noderef of the newly created folder.

    • deleteFolder

      void deleteFolder(NodeRef folderNodeRef)
      Deletes a folder with a specific noderef.
      Parameters:
      folderNodeRef - The noderef of the folder that is requested to be deleted.