Package com.uc4.api.objects

Interface IFolder

All Known Implementing Classes:
FolderImpl
public interface IFolder
This interface represents a folder.

  • Method Details

    • getName

      String getName()
      Returns the name of the folder.
      Returns:
      name

    • getTitle

      String getTitle()
      Returns the title of the folder.
      Returns:
      title

    • getId

      String getId()
      Returns the ID of the folder.
      Returns:
      ID

    • getType

      String getType()
      Returns the type of this folder
      • CLNT ... Client, Root folder, exists only once
      • NFOLD ... No Folder, exists only once
      • FAV ... Favorites folder, exists only once
      • USERF ... User favorites
      • USRGF ... User Group favorites
      • TRANSCASE ... Transport folder
      • VERSCONTROL ... Version Management folder
      • RCNT ... Recent Objects
      • TRASH ... Recycle Bin
      • FOLD ... Normal folder
      Returns:
      Folder type

    • subfolder

      Iterator<IFolder> subfolder()
      Returns an iterator for subfolders Each object in the list implements the IFolder interface. If there are no subfolders this method returns null.
      Returns:
      list of subfolders

    • getSubFolder

      IFolder getSubFolder(String name, boolean recursive)
      Returns a subfolder with the specified name.
      Parameters:
      name - Name of the subfolder
      recursive - true if recursive false otherwise
      Returns:
      object which implements IFolder

    • getParent

      IFolder getParent()
      Returns the parent folder of this folder.
      Returns:
      parent folder

    • fullPath

      String fullPath()
      Returns the full path of this folder. Each folder is separated by a /
      Returns:
      path