sbIMetadataLookupJob Interface Reference

import"sbIMetadataLookupData.idl";

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

Public Member Functions

void init (in unsigned short jobType, in unsigned short status)
 Initialise the job type and state of the job. More...
 
void appendResult (in sbIMetadataAlbumDetail aAlbum)
 Append a result. More...
 
void changeStatus (in unsigned short status)
 Change the status of the job and notify listeners. More...
 
nsISimpleEnumerator getMetadataResults ()
 Returns an enumerator of all results found by this lookup job. More...
 
- 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...
 

Public Attributes

const unsigned short JOB_DISC_LOOKUP = 1
 
const unsigned short JOB_ALBUM_DETAIL_LOOKUP = 2
 
readonly attribute unsigned short mlJobType
 
readonly attribute unsigned short mlNumResults
 
- 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...
 

Detailed Description

Definition at line 57 of file sbIMetadataLookupData.idl.

Member Function Documentation

void sbIMetadataLookupJob::appendResult ( in sbIMetadataAlbumDetail  aAlbum)

Append a result.

void sbIMetadataLookupJob::changeStatus ( in unsigned short  status)

Change the status of the job and notify listeners.

nsISimpleEnumerator sbIMetadataLookupJob::getMetadataResults ( )

Returns an enumerator of all results found by this lookup job.

Returns
Enumerator of sbIMetadataAlbumDetail items
void sbIMetadataLookupJob::init ( in unsigned short  jobType,
in unsigned short  status 
)

Initialise the job type and state of the job.

Member Data Documentation

const unsigned short sbIMetadataLookupJob::JOB_ALBUM_DETAIL_LOOKUP = 2

Definition at line 60 of file sbIMetadataLookupData.idl.

const unsigned short sbIMetadataLookupJob::JOB_DISC_LOOKUP = 1

Definition at line 59 of file sbIMetadataLookupData.idl.

readonly attribute unsigned short sbIMetadataLookupJob::mlJobType

Definition at line 65 of file sbIMetadataLookupData.idl.

readonly attribute unsigned short sbIMetadataLookupJob::mlNumResults

Definition at line 68 of file sbIMetadataLookupData.idl.


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