Inheritance diagram for sbILocalDatabaseMigrationHandler:

Collaboration diagram for sbILocalDatabaseMigrationHandler:

Public Member Functions
void	migrate (in sbILocalDatabaseLibrary aLibrary)
	Run the migration handler on a library. 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
readonly attribute unsigned long	fromVersion
	The source schema version. More...

readonly attribute unsigned long	toVersion
	The destination schema version. 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...

Detailed Description

Note: For your migration handler to be picked up by the LocalDatabaseMigration Component, it must have a contract id that begins with the following: "@songbirdnest.com/Songbird/Library/LocalDatabase/Migration/Handler/"

Member Function Documentation

void sbILocalDatabaseMigrationHandler::migrate ( in sbILocalDatabaseLibrary aLibrary )

Run the migration handler on a library.

readonly attribute unsigned long sbILocalDatabaseMigrationHandler::fromVersion

The source schema version.

readonly attribute unsigned long sbILocalDatabaseMigrationHandler::toVersion

The destination schema version.

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

/home/martin/dev/nightingale-hacking/components/library/localdatabase/public/sbILocalDatabaseMigrationHandler.idl