sbIJobProgressTime Interface Reference

Generic interface extending sbIJobProgress that can track expected time, etc in addition to abstract work units. More...

import"sbIJobProgress.idl";

Inheritance diagram for sbIJobProgressTime:
[legend]
Collaboration diagram for sbIJobProgressTime:
[legend]

Public Attributes

readonly attribute unsigned long elapsedTime
 Time elapsed while working on this job, in milliseconds. More...
 
readonly attribute unsigned long remainingTime
 Estimated time remaining for this job to complete, in milliseconds. May be -1 if the remaining time is indeterminate. More...
 
- Public Attributes inherited from sbIJobProgress
const unsigned short STATUS_FAILED = 0x00
 Constant indicating that the job has completed with errors. More...
 
const unsigned short STATUS_SUCCEEDED = 0x10
 Constant indicating that the job has completed. More...
 
const unsigned short STATUS_RUNNING = 0x20
 Constant indicating that the job is active. More...
 
readonly attribute unsigned short status
 Current status of the job. More...
 
readonly attribute boolean blocked
 If true, progress of job is blocked (e.g., due to locked resource). More...
 
readonly attribute AString statusText
 Localized message describing the status of the job. More...
 
readonly attribute AString titleText
 Localized message describing the type or purpose of the job. More...
 
readonly attribute unsigned long progress
 Number of work units completed. More...
 
readonly attribute unsigned long total
 Total number of work units to be completed May be set to 0 if the job length is indeterminate. More...
 
readonly attribute unsigned long errorCount
 Number of errors that have been encountered. More...
 

Additional Inherited Members

- Public Member Functions inherited from sbIJobProgress
nsIStringEnumerator getErrorMessages ()
 Enumerate all the errors encountered during the job. More...
 
void addJobProgressListener (in sbIJobProgressListener aListener)
 Add a listener to be notified when significant job progress has been made. More...
 
void removeJobProgressListener (in sbIJobProgressListener aListener)
 Remove a previously added listener. More...
 

Detailed Description

Generic interface extending sbIJobProgress that can track expected time, etc in addition to abstract work units.

Definition at line 146 of file sbIJobProgress.idl.

Member Data Documentation

readonly attribute unsigned long sbIJobProgressTime::elapsedTime

Time elapsed while working on this job, in milliseconds.

Definition at line 151 of file sbIJobProgress.idl.

readonly attribute unsigned long sbIJobProgressTime::remainingTime

Estimated time remaining for this job to complete, in milliseconds. May be -1 if the remaining time is indeterminate.

Definition at line 157 of file sbIJobProgress.idl.


The documentation for this interface was generated from the following file: