Interface IProgressReport

All Known Implementing Classes:
ProgressReporter.ProgressReport
public interface IProgressReport
The interface for a progress report; a progress report is a read only object containing all the properties of an IProgressReporter at a moment in time

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDetailMessage()
    Returns the detail message for this particular report
    String
    getErrorMessage()
    Returns the error message (if any) for this report
    org.eclipse.swt.graphics.Image
    getImage()
    Returns the image of the reporter
    int
    getMaximum()
    Returns the maximum amount of work to be done
    String
    getMessage()
    Returns the message for this particular report
    int
    getMinimum()
    Returns the minimum amount of work to be done
    String
    getName()
    Returns the name of the reporter
    Object
    getObjectData()
    Returns the object associated with this report
    int
    getPercentage()
    Returns the percentage of work done so far
    IProgressReporter
    getReporter()
     
    int
    getReporterID()
    Returns the id of the reporter that created this report
    String
    getReporterType()
    Returns the reporter type of the reporter that created this report
    int
    getReportType()
    Returns the type of report this is
    int
    getSelection()
    Returns the amount of work done so far
    String
    getTitle()
    Returns the title of the reporter; this is mainly used as a window title if the reporter is shown by itself in a window
    boolean
    isActive()
    Returns whether the reporter is still in active state
    boolean
    isCancelAllowed()
    Returns whether the process owning the reporter allows a cancel request
    boolean
    isCanceled()
    Returns whether the reporter has been canceled
    boolean
    isDisposed()
    Returns whether the reporter has been marked for disposal
    boolean
    isDone()
    Returns whether the reporter is done with all its work
    boolean
    isIndeterminate()
    Returns whether the amount of work done so far can not be calculated accurately
    boolean
    isInErrorState()
    Returns whether the reporter has reported an error
    boolean
    isPercentageInUse()
    Returns whether the amount of work done is in percentage form
    boolean
    isRetryAllowed()
    Returns whether the process owning the reporter allows a retry request

  • Method Details

    • getReporter

      IProgressReporter getReporter()

    • getReporterType

      String getReporterType()
      Returns the reporter type of the reporter that created this report
      Returns:

    • getReporterID

      int getReporterID()
      Returns the id of the reporter that created this report
      Returns:

    • getMinimum

      int getMinimum()
      Returns the minimum amount of work to be done
      Returns:

    • getMaximum

      int getMaximum()
      Returns the maximum amount of work to be done
      Returns:

    • getSelection

      int getSelection()
      Returns the amount of work done so far
      Returns:

    • getPercentage

      int getPercentage()
      Returns the percentage of work done so far
      Returns:

    • isActive

      boolean isActive()
      Returns whether the reporter is still in active state
      Returns:

    • isIndeterminate

      boolean isIndeterminate()
      Returns whether the amount of work done so far can not be calculated accurately
      Returns:

    • isDone

      boolean isDone()
      Returns whether the reporter is done with all its work
      Returns:

    • isPercentageInUse

      boolean isPercentageInUse()
      Returns whether the amount of work done is in percentage form
      Returns:

    • isCancelAllowed

      boolean isCancelAllowed()
      Returns whether the process owning the reporter allows a cancel request
      Returns:

    • isCanceled

      boolean isCanceled()
      Returns whether the reporter has been canceled
      Returns:

    • isRetryAllowed

      boolean isRetryAllowed()
      Returns whether the process owning the reporter allows a retry request
      Returns:

    • isInErrorState

      boolean isInErrorState()
      Returns whether the reporter has reported an error
      Returns:

    • isDisposed

      boolean isDisposed()
      Returns whether the reporter has been marked for disposal
      Returns:

    • getTitle

      String getTitle()
      Returns the title of the reporter; this is mainly used as a window title if the reporter is shown by itself in a window
      Returns:

    • getMessage

      String getMessage()
      Returns the message for this particular report
      Returns:

    • getDetailMessage

      String getDetailMessage()
      Returns the detail message for this particular report
      Returns:

    • getErrorMessage

      String getErrorMessage()
      Returns the error message (if any) for this report
      Returns:

    • getName

      String getName()
      Returns the name of the reporter
      Returns:

    • getImage

      org.eclipse.swt.graphics.Image getImage()
      Returns the image of the reporter
      Returns:

    • getObjectData

      Object getObjectData()
      Returns the object associated with this report
      Returns:

    • getReportType

      int getReportType()
      Returns the type of report this is
      Returns: