OpenSim::Data::MSSQL::MSSQLInventoryData

OpenSim::Data::MSSQL::MSSQLInventoryData Class Reference

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

Inheritance diagram for OpenSim::Data::MSSQL::MSSQLInventoryData:

OpenSim::Framework::IInventoryDataPlugin OpenSim::Framework::IPlugin List of all members.

Public Member Functions

void Initialise (string connectionString)
 Loads and initialises the MSSQL inventory storage interface.
void Dispose ()
 Closes this DB provider.
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)
 Returns a list of folders in a users inventory contained within the specified folder.
InventoryFolderBase getInventoryFolder (UUID folderID)
 Returns a specified inventory folder.
List< InventoryFolderBase > getFolderHierarchy (UUID parentID)
 Returns all child folders in the hierarchy from the parent folder and down. Does not return the parent folder itself.
void addInventoryFolder (InventoryFolderBase folder)
 Creates a new inventory folder.
void updateInventoryFolder (InventoryFolderBase folder)
 Updates an inventory folder.
void moveInventoryFolder (InventoryFolderBase folder)
 Updates an inventory folder.
void deleteInventoryFolder (UUID folderID)
 Delete an inventory folder.
List< InventoryItemBase > getInventoryInFolder (UUID folderID)
 Returns a list of items in a specified folder.
InventoryItemBase getInventoryItem (UUID itemID)
 Returns a specified inventory item.
void addInventoryItem (InventoryItemBase item)
 Adds a specified item to the database.
void updateInventoryItem (InventoryItemBase item)
 Updates the specified inventory item.
void deleteInventoryItem (UUID itemID)
 Delete an item in inventory database.
List< InventoryItemBase > fetchActiveGestures (UUID avatarID)
 Returns all activated gesture-items in the inventory of the specified avatar.

Static Protected Member Functions

static InventoryFolderBase readInventoryFolder (IDataReader 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 MSSQL interface for the inventory server.

Member Function Documentation

void OpenSim::Data::MSSQL::MSSQLInventoryData::Initialise ( string  connectionString  )  [inline]

Loads and initialises the MSSQL inventory storage interface.

Parameters:
connectionString connect string
use mssql_connection.ini

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::Dispose (  )  [inline]

Closes this DB provider.

List<InventoryFolderBase> OpenSim::Data::MSSQL::MSSQLInventoryData::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::MSSQL::MSSQLInventoryData::getUserRootFolder ( UUID  user  )  [inline]

see InventoryItemBase.getUserRootFolder

Parameters:
user the User UUID
Returns:

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::MSSQL::MSSQLInventoryData::getInventoryFolders ( UUID  parentID  )  [inline]

Returns a list of folders in a users inventory contained within the specified folder.

Parameters:
parentID The folder to search
Returns:
A list of inventory folders

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryFolderBase OpenSim::Data::MSSQL::MSSQLInventoryData::getInventoryFolder ( UUID  folderID  )  [inline]

Returns a specified inventory folder.

Parameters:
folderID The folder to return
Returns:
A folder class

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::MSSQL::MSSQLInventoryData::getFolderHierarchy ( UUID  parentID  )  [inline]

Returns all child folders in the hierarchy from the parent folder and down. Does not return the parent folder itself.

Parameters:
parentID The folder to get subfolders for
Returns:
A list of inventory folders

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::addInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Creates a new inventory folder.

Parameters:
folder Folder to create

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::updateInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Updates an inventory folder.

Parameters:
folder Folder to update

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::moveInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Updates an inventory folder.

Parameters:
folder Folder to update

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::deleteInventoryFolder ( UUID  folderID  )  [inline]

Delete an inventory folder.

Parameters:
folderID Id of folder to delete

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryItemBase> OpenSim::Data::MSSQL::MSSQLInventoryData::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.

InventoryItemBase OpenSim::Data::MSSQL::MSSQLInventoryData::getInventoryItem ( UUID  itemID  )  [inline]

Returns a specified inventory item.

Parameters:
itemID The item ID
Returns:
An inventory item

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::addInventoryItem ( InventoryItemBase  item  )  [inline]

Adds a specified item to the database.

Parameters:
item The inventory item

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::updateInventoryItem ( InventoryItemBase  item  )  [inline]

Updates the specified inventory item.

Parameters:
item Inventory item to update

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::MSSQL::MSSQLInventoryData::deleteInventoryItem ( UUID  itemID  )  [inline]

Delete an item in inventory database.

Parameters:
itemID the item UUID

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryItemBase> OpenSim::Data::MSSQL::MSSQLInventoryData::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.

static InventoryFolderBase OpenSim::Data::MSSQL::MSSQLInventoryData::readInventoryFolder ( IDataReader  reader  )  [inline, static, protected]

Reads a list of inventory folders returned by a query.

Parameters:
reader A MSSQL Data Reader
Returns:
A List containing inventory folders

Property Documentation

string OpenSim::Data::MSSQL::MSSQLInventoryData::Name [get]

The name of this DB provider.

Returns:
A string containing the name of the DB provider

Implements OpenSim::Framework::IPlugin.

string OpenSim::Data::MSSQL::MSSQLInventoryData::Version [get]

Returns the version of this DB provider.

Returns:
A string containing the DB provider

Implements OpenSim::Framework::IPlugin.

The documentation for this class was generated from the following file:
Generated on Mon Jan 5 01:00:38 2009 for OpenSim by  doxygen 1.5.1