tmozIDomainManager Interface Reference

Domain manager. More...

List of all members.

Public Member Functions

tmozIDomain get (in AString name)
 Return domain by name Function can be used to get specific domain.
tmozIDomain createFromFile (in AString sourceFile, in boolean copyFile)
 Create new domain from file.
tmozIDomain create (in AString domainId, in AString domainName)
 Create new domain.
void remove (in tmozIDomain domain)
 Remove domain.
void registerListener (in tmozIDomainManagerListener listener)
 Register Listener.
void unregisterListener (in tmozIDomainManagerListener listener)
 Listener to be unregistered.

Public Attributes

readonly attribute
nsISimpleEnumerator 
domains
 Domain enumerator.


Detailed Description

Domain manager.

This is manager for domains.


Member Function Documentation

tmozIDomain create ( in AString  domainId,
in AString  domainName 
)

Create new domain.

Function creates empty domain.

Parameters:
domainId ID of the new domain. This value cannot be later changed.
domainName Name of new domain. This name is user visible.
Returns:
Return newly created domain. Throw exception if domain already exists or other error.

tmozIDomain createFromFile ( in AString  sourceFile,
in boolean  copyFile 
)

Create new domain from file.

Function will create domain from the existing source file.

Parameters:
sourceFile path to the file
copyFile Flag if source file should be copied to the domain directory as domain.xml
Returns:
Return newly created domain. Throw exception if domain creation failed.

tmozIDomain get ( in AString  name  ) 

Return domain by name Function can be used to get specific domain.

Parameters:
name Domain name.
Returns:
Return domain. Return NULL if domain does not exist.

void registerListener ( in tmozIDomainManagerListener  listener  ) 

Register Listener.

Parameters:
listener Listener which will receive notifications about domain changes

void remove ( in tmozIDomain  domain  ) 

Remove domain.

Function will remove domain. Only inactive domain can be removed.

Parameters:
domain Domain to be removed.
Note:
Removed domain cannot be longer used.

void unregisterListener ( in tmozIDomainManagerListener  listener  ) 

Listener to be unregistered.

Parameters:
listener Listener which will be unregistered.


Member Data Documentation

readonly attribute nsISimpleEnumerator domains

Domain enumerator.

Domain supports tmozIDomain interface.


Generated on Thu Aug 27 12:37:06 2009 for Tahiti XPCOM API