Package com.appliedolap.essbase

Interface EssFile

All Superinterfaces:
EssObject
All Known Subinterfaces:
EssFolder
All Known Implementing Classes:
EssFileImpl, EssFolderImpl
public interface EssFile extends EssObject

  • Method Details

    • getName

      String getName()
      Returns the filename portion of the file.
      Specified by:
      getName in interface EssObject
      Returns:
      the filename

    • getType

      EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssObject
      Returns:
      the object type

    • getFullPath

      String getFullPath()
      Returns the full path of the file, i.e. the combination of its path and filename.
      Returns:
      the full path of the file

    • getPath

      String getPath()
      Convenience method to return the path to the file.
      Returns:
      the path of this file

    • isFolder

      boolean isFolder()
      Checks if this file object represents a file or a folder. If this method returns true, then this class may be cast to EssFolderImpl, which is a subclass of this one.
      Returns:
      true if this object represents a folder, false otherwise

    • isFile

      boolean isFile()
      Returns true if this is a file, not a folder.
      Returns:
      true if this object is a file

    • getServer

      EssServer getServer()
      Returns the owning Essbase server instance for this file.
      Returns:
      the Essbase server parent object

    • download

      File download()
      Downloads this file to the current directory
      Returns:
      a local file system reference to the downloaded file

    • downloadToFolder

      File downloadToFolder(File folder)
      Downloads the file to a particular folder). TODO: check if folder and download there, if not, download as specific file
      Parameters:
      folder - the folder
      Returns:
      a local filesystem reference to the created file

    • delete

      void delete()
      Delete this file.

    • lcmImport

      @Deprecated void lcmImport()
      Deprecated.

    • copy

      void copy(EssFilePathDetail body, Boolean overwrite)
      Copy a file from source to destination.
      Parameters:
      body - File path details.(required)
      overwrite - Overwrite existing file. (optional, default to false)

    • move

      void move(EssFilePathDetail body, Boolean overwrite)
      Moves a file from source to destination. Moving a folder is not supported
      Parameters:
      body - File path details.(required)
      overwrite - Overwrite existing file. Only applicable for moving a file. (optional, default to false)

    • rename

      void rename(EssFilePathDetail body, Boolean overwrite)
      Renames a file or folder. Renaming a folder is supported only if the folder is not in the applications directory
      Parameters:
      body - File path details.(required)
      overwrite - Overwrite existing file. Only applicable for renaming a file. (optional, default to false)

    • extract

      void extract(EssZipFileDetails body, Boolean overwrite)
      Extract a zip file on same location. Supported for applications, users, and shared folders.
      Parameters:
      body - File path details.(required)
      overwrite - Overwrite existing file. Not applicable for folder. (optional, default to false)