Package com.uc4.api.objects

Interface IFolder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String fullPath()
      Returns the full path of this folder.
      java.lang.String getId()
      Returns the ID of the folder.
      java.lang.String getName()
      Returns the name of the folder.
      IFolder getParent()
      Returns the parent folder of this folder.
      IFolder getSubFolder​(java.lang.String name, boolean recursive)
      Returns a subfolder with the specified name.
      java.lang.String getTitle()
      Returns the title of the folder.
      java.lang.String getType()
      Returns the type of this folder CLNT ...
      java.util.Iterator<IFolder> subfolder()
      Returns an iterator for subfolders Each object in the list implements the IFolder interface.

    • Method Detail

      • getName

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

      • getTitle

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

      • getId

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

      • getType

        java.lang.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

        java.util.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​(java.lang.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

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