OpenSim::Data::MySQL::MySQLInventoryData Class Reference

A MySQL interface for the inventory server. More...

Inheritance diagram for OpenSim::Data::MySQL::MySQLInventoryData:

List of all members.

Public Member Functions
void	Initialise ()
	Default-initialises the plugin.
void	Initialise (string connect)
	Initialises Inventory interface Loads and initialises the MySQL storage plugin warns and uses the obsolete mysql_connection.ini if connect string is empty. Check for migration
void	Dispose ()
	Closes this DB provider.
List< InventoryItemBase >	getInventoryInFolder (UUID folderID)
	Returns a list of items in a specified folder.
List< InventoryFolderBase >	getUserRootFolders (UUID user)
	Returns a list of the root folders within a users inventory.
InventoryFolderBase	getUserRootFolder (UUID user)
	see InventoryItemBase::getUserRootFolder
List< InventoryFolderBase >	getInventoryFolders (UUID parentID)
	Return a list of folders in a users inventory contained within the specified folder. This method is only used in tests - in normal operation the user always have one, and only one, root folder.
InventoryItemBase	getInventoryItem (UUID itemID)
	Returns a specified inventory item.
InventoryFolderBase	getInventoryFolder (UUID folderID)
	Returns a specified inventory folder.
void	addInventoryItem (InventoryItemBase item)
	Adds a specified item to the database.
void	updateInventoryItem (InventoryItemBase item)
	Updates the specified inventory item.
void	deleteInventoryItem (UUID itemID)
	Detele the specified inventory item.
void	addInventoryFolder (InventoryFolderBase folder)
	Creates a new inventory folder.
void	updateInventoryFolder (InventoryFolderBase folder)
	Updates an inventory folder.
void	moveInventoryFolder (InventoryFolderBase folder)
	Move an inventory folder.
List< InventoryFolderBase >	getFolderHierarchy (UUID parentID)
	See IInventoryDataPlugin.
void	deleteInventoryFolder (UUID folderID)
	Deletes an inventory folder.
List< InventoryItemBase >	fetchActiveGestures (UUID avatarID)
	Returns all activated gesture-items in the inventory of the specified avatar.
Protected Member Functions
void	getInventoryFolders (ref List< InventoryFolderBase > folders, UUID parentID)
	Append a list of all the child folders of a parent folder.
void	deleteOneFolder (UUID folderID)
	Delete a folder from database.
void	deleteItemsInFolder (UUID folderID)
	Delete all item in a folder.
Static Protected Member Functions
static InventoryFolderBase	readInventoryFolder (MySqlDataReader reader)
	Reads a list of inventory folders returned by a query.
Properties
string	Name [get]
	The name of this DB provider.
string	Version [get]
	Returns the version of this DB provider.

---

Detailed Description

A MySQL interface for the inventory server.

---

Member Function Documentation

void OpenSim::Data::MySQL::MySQLInventoryData::Initialise

(

)

[inline]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::Initialise

(

string

connect

)

[inline]

Initialises Inventory interface

• Loads and initialises the MySQL storage plugin
• warns and uses the obsolete mysql_connection.ini if connect string is empty.
• Check for migration

Parameters:

connect

connect string

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::Dispose

(

)

[inline]

Closes this DB provider.

do nothing

List<InventoryItemBase> OpenSim::Data::MySQL::MySQLInventoryData::getInventoryInFolder

(

UUID

folderID

)

[inline]

Returns a list of items in a specified folder.

Parameters:

folderID

The folder to search

Returns:

A list containing inventory items

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::MySQL::MySQLInventoryData::getUserRootFolders

(

UUID

user

)

[inline]

Returns a list of the root folders within a users inventory.

Parameters:

user

The user whos inventory is to be searched

Returns:

A list of folder objects

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryFolderBase OpenSim::Data::MySQL::MySQLInventoryData::getUserRootFolder

(

UUID

user

)

[inline]

see InventoryItemBase::getUserRootFolder

Parameters:

user

The user UUID

Returns:

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::MySQL::MySQLInventoryData::getInventoryFolders

(

UUID

parentID

)

[inline]

Return a list of folders in a users inventory contained within the specified folder. This method is only used in tests - in normal operation the user always have one, and only one, root folder.

Parameters:

parentID

The folder to search

Returns:

A list of inventory folders

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryItemBase OpenSim::Data::MySQL::MySQLInventoryData::getInventoryItem

(

UUID

itemID

)

[inline]

Returns a specified inventory item.

Parameters:

item

The item to return

Returns:

An inventory item

Implements OpenSim::Framework::IInventoryDataPlugin.

static InventoryFolderBase OpenSim::Data::MySQL::MySQLInventoryData::readInventoryFolder

(

MySqlDataReader

reader

)

[inline, static, protected]

Reads a list of inventory folders returned by a query.

Parameters:

reader

A MySQL Data Reader

Returns:

A List containing inventory folders

InventoryFolderBase OpenSim::Data::MySQL::MySQLInventoryData::getInventoryFolder

(

UUID

folderID

)

[inline]

Returns a specified inventory folder.

Parameters:

folder

The folder to return

Returns:

A folder class

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::addInventoryItem

(

InventoryItemBase

item

)

[inline]

Adds a specified item to the database.

Parameters:

item

The inventory item

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::updateInventoryItem

(

InventoryItemBase

item

)

[inline]

Updates the specified inventory item.

Parameters:

item

Inventory item to update

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::deleteInventoryItem

(

UUID

itemID

)

[inline]

Detele the specified inventory item.

Parameters:

item

The inventory item UUID to delete

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::addInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Creates a new inventory folder.

Parameters:

folder

Folder to create

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::updateInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Updates an inventory folder.

Parameters:

folder

Folder to update

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::moveInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Move an inventory folder.

Parameters:

folder

Folder to move

UPDATE inventoryfolders SET parentFolderID=?parentFolderID WHERE folderID=?folderID

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::getInventoryFolders	(	ref List< InventoryFolderBase >	folders,
		UUID	parentID
	)			[inline, protected]

Append a list of all the child folders of a parent folder.

Parameters:

	folders	list where folders will be appended
	parentID	ID of parent

List<InventoryFolderBase> OpenSim::Data::MySQL::MySQLInventoryData::getFolderHierarchy

(

UUID

parentID

)

[inline]

See IInventoryDataPlugin.

Parameters:

parentID

Returns:

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MySQL::MySQLInventoryData::deleteOneFolder

(

UUID

folderID

)

[inline, protected]

Delete a folder from database.

Parameters:

folderID

the folder UUID

void OpenSim::Data::MySQL::MySQLInventoryData::deleteItemsInFolder

(

UUID

folderID

)

[inline, protected]

Delete all item in a folder.

Parameters:

folderID

the folder UUID

void OpenSim::Data::MySQL::MySQLInventoryData::deleteInventoryFolder

(

UUID

folderID

)

[inline]

Deletes an inventory folder.

Parameters:

folderId

Id of folder to delete

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryItemBase> OpenSim::Data::MySQL::MySQLInventoryData::fetchActiveGestures

(

UUID

avatarID

)

[inline]

Returns all activated gesture-items in the inventory of the specified avatar.

Parameters:

avatarID

The UUID of the avatar

Returns:

The list of gestures (InventoryItemBases)

Implements OpenSim::Framework::IInventoryDataPlugin.

---

Property Documentation

string OpenSim::Data::MySQL::MySQLInventoryData::Name [get]

The name of this DB provider.

Returns:

Name of DB provider

Implements OpenSim::Framework::IPlugin.

string OpenSim::Data::MySQL::MySQLInventoryData::Version [get]

Returns the version of this DB provider.

Returns:

A string containing the DB provider version

Implements OpenSim::Framework::IPlugin.

---

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

• /home/sdague/opensim-docs/OpenSim/Data/MySQL/MySQLInventoryData.cs

---