Interface FolderItem

All Superinterfaces:
Comparable<FileSystemItem>, FileSystemItem
All Known Implementing Classes:
AbstractVirtualFolderItem, CollectionSyncRootFolderItem, DefaultSyncRootFolderItem, DefaultTopLevelFolderItem, DocumentBackedFolderItem, ESSyncRootFolderItem, PermissionTopLevelFolderItem, SharedSyncRootParentFolderItem, UserSyncRootParentFolderItem, UserWorkspaceSyncRootParentFolderItem, UserWorkspaceTopLevelFolderItem

public interface FolderItem extends FileSystemItem
Representation of a folder.

In the case of a DocumentModel backed implementation, the backing document is Folderish. Typically a Folder or a Workspace.

Author:
Antoine Taillefer
See Also:
  • Method Details

    • getChildren

      List<FileSystemItem> getChildren()
    • getCanScrollDescendants

      boolean getCanScrollDescendants()
      Returns true if the scrollDescendants(String, int, long) API can be used.
      Since:
      8.3
    • scrollDescendants

      ScrollFileSystemItemList scrollDescendants(String scrollId, int batchSize, long keepAlive)
      Retrieves at most batchSize FileSystemItem descendants for the given scrollId.

      When passing a null scrollId the initial search request is executed and the first batch of results is returned along with a scrollId which should be passed to the next call in order to retrieve the next batch of results.

      Ideally, the search context made available by the initial search request is kept alive during keepAlive milliseconds if keepAlive is positive.

      Results are not necessarily sorted.

      This method is protected by a Semaphore, made available by FileSystemItemAdapterService.getScrollBatchSemaphore(), to limit the number of concurrent executions and avoid too much memory pressure.

      Throws:
      UnsupportedOperationException - if getCanScrollDescendants() returns false.
      Since:
      8.3
    • getCanCreateChild

      boolean getCanCreateChild()
    • createFile

      FileItem createFile(Blob blob, boolean overwrite)
      Parameters:
      overwrite - allows to overwrite an existing file with the same title
      Since:
      9.1
    • createFolder

      FolderItem createFolder(String name, boolean overwrite)
      Parameters:
      overwrite - allows to overwrite an existing folder with the same title
      Since:
      9.1