tmozIDomainConfiguration Interface Reference

Domain configuration. More...

List of all members.

Public Member Functions
nsISupportsArray	getItems ()
	List of configuration items.
boolean	hasValue (in AString name)
	Return if configuration exists.
boolean	addValue (in long itemType, in AString name, in AString value)
	Add value.
void	deleteItem (in AString name)
	Delete Item.
AString	getValue (in AString name)
	Return configuration value.
boolean	setValue (in AString name, in AString value)
	Set value.
long	getItemSource (in AString name)
	Return source of the item.
AString	expandVariables (in AString value)
	Expand variables.
Public Attributes
const long	SOURCE_DOMAIN = 0
	Specific option is defined in the domain.xml.
const long	SOURCE_CONFIG = 1
	Specific option is defined in the config.xml.
const long	SOURCE_USER = 2
	Specific option is defined by the user.

---

Detailed Description

Domain configuration.

Domain specific configuration. Object can be used to access domain configuration. If requested value is not member of the domain configuration it will be returned/set in shared configuration.

---

Member Function Documentation

boolean addValue	(	in long	itemType,
		in AString	name,
		in AString	value
	)

Add value.

Add item and value to the configuration.

Parameters:

	itemType	type of the item. Type if one of the following SOURCE_DOMAIN value will be stored in the domain.xml SOURCE_CONFIG value will be stored in the config.xml SOURCE_USER value will not be stored in the configuration file
	name	Name of the new item
	value	New value

Returns:

Return true if configuration was set. Return false if error or item already exists.

void deleteItem

(

in AString

name

)

Delete Item.

Delete item from this configuration object.

Parameters:

name

Name of the deleted item

AString expandVariables

(

in AString

value

)

Expand variables.

Function will expand variables in the string. Variables are written like VARIABLE%.

List of available variables:

• TAHITI_USER - user name - name of logged user
• TAHITI_PASSWORD - password
• TAHITI_REPOSITORY - path to the repository
• TAHITI_DOMAIN - domain
• TAHITI_BIN_PATH - path to the binaries
• CSIDL_DESKTOPDIRECTORY - desktop directory
• CSIDL_PERSONAL - documents folder
• CSIDL_APPDATA - application folder
• CSIDL_LOCAL_APPDATA - local application folder (not part of roaming profiles)
• CSIDL_PROGRAM_FILES - program files

nsISupportsArray getItems

(

)

List of configuration items.

List contains strings - names of items

long getItemSource

(

in AString

name

)

Return source of the item.

Source of the item can be:

• SOURCE_DOMAIN
• SOURCE_CONFIG
• SOURCE_USER

AString getValue

(

in AString

name

)

Return configuration value.

Return domain specific value for given configuration. If value is not found in the domain configuration method return value from shared configuration.

Parameters:

name

Name of the item

Returns:

Return value of the item. Throw exception if option does not exist.

boolean hasValue

(

in AString

name

)

Return if configuration exists.

Parameters:

name

Name of the item.

Returns:

Return true if configuration exists. Return false if configuration does not exists.

boolean setValue	(	in AString	name,
		in AString	value
	)

Set value.

Set value of existing configuration.

Parameters:

	name	Name of the item
	value	New value

Returns:

Return true if configuration was set. Return false if error or item does not exists.

---

Member Data Documentation

const long SOURCE_CONFIG = 1

Specific option is defined in the config.xml.

config.xml can be uploaded to the server

const long SOURCE_DOMAIN = 0

Specific option is defined in the domain.xml.

domain.xml is core configuration file for the domain. This file is always located on the client computer.