Package com.iizix.wsfile

Interface IWSFileDownload

All Known Implementing Classes:
WSFileDownload
public interface IWSFileDownload
Interface used to hold information for file download into a file provider.
Author:
Christopher Mindus

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    dispose()
    Disposes of the download if in progress.
    String
    getDescription()
    Gets the description of the download file.
    Throwable
    getException()
    Gets the exception from the download process or when writing the file.
    File
    getFile()
    Gets the download file.
    Object
    getID()
    Gets the ID used for database identification.
    URL
    getURL()
    Gets the URL.
    boolean
    isDisposed()
    Checks if the download is disposed of (during progress).

  • Method Details Link icon

    • getURL Link icon

      URL getURL()
      Gets the URL.
      Returns:
      The URL.

    • getID Link icon

      Object getID()
      Gets the ID used for database identification.
      Returns:
      A Long or String, null when database is not used.

    • getDescription Link icon

      String getDescription()
      Gets the description of the download file.
      Returns:
      The description.

    • getFile Link icon

      File getFile()
      Gets the download file.
      Returns:
      The file, or null if an exception occurred.

    • getException Link icon

      Throwable getException()
      Gets the exception from the download process or when writing the file.
      Returns:
      The exception, or null if no error occurred.

    • dispose Link icon

      void dispose()
      Disposes of the download if in progress.

    • isDisposed Link icon

      boolean isDisposed()
      Checks if the download is disposed of (during progress).
      Returns:
      The dispose flag: true if download has been disposed of, i.e. canceled, false otherwise.