An interface for accessing inventory data from a storage server More...

Inheritance diagram for OpenSim.Data.IInventoryDataPlugin:

Collaboration diagram for OpenSim.Data.IInventoryDataPlugin:

Public Member Functions
void	Initialise (string connect)
	Initialises the interface More...

List< InventoryFolderBase >	getFolderHierarchy (UUID parentID)
	Returns all descendent folders of this folder. Does not return the parent folder itself. More...

List< InventoryItemBase >	getInventoryInFolder (UUID folderID)
	Returns a list of inventory items contained within the specified folder More...

List< InventoryFolderBase >	getUserRootFolders (UUID user)
	Returns a list of the root folders within a users inventory More...

InventoryFolderBase	getUserRootFolder (UUID user)
	Returns the users inventory root folder. More...

List< InventoryFolderBase >	getInventoryFolders (UUID parentID)
	Returns a list of inventory folders contained in the folder 'parentID' More...

InventoryItemBase	getInventoryItem (UUID item)
	Returns an inventory item by its UUID More...

InventoryFolderBase	getInventoryFolder (UUID folder)
	Returns a specified inventory folder by its UUID More...

void	addInventoryItem (InventoryItemBase item)
	Creates a new inventory item based on item More...

void	updateInventoryItem (InventoryItemBase item)
	Updates an inventory item with item (updates based on ID) More...

void	deleteInventoryItem (UUID item)

InventoryItemBase	queryInventoryItem (UUID item)

InventoryFolderBase	queryInventoryFolder (UUID folder)

void	addInventoryFolder (InventoryFolderBase folder)
	Adds a new folder specified by folder More...

void	updateInventoryFolder (InventoryFolderBase folder)
	Updates a folder based on its ID with folder More...

void	moveInventoryFolder (InventoryFolderBase folder)
	Updates a folder based on its ID with folder More...

void	deleteInventoryFolder (UUID folder)
	Deletes a folder. Thie will delete both the folder itself and its contents (items and descendent folders) More...

List< InventoryItemBase >	fetchActiveGestures (UUID avatarID)
	Returns all activated gesture-items in the inventory of the specified avatar. More...

Public Member Functions inherited from OpenSim.Framework.IPlugin
void	Initialise ()
	Default-initialises the plugin More...

Additional Inherited Members
Properties inherited from OpenSim.Framework.IPlugin
string	Version `[get]`
	Returns the plugin version More...

string	Name `[get]`
	Returns the plugin name More...

Detailed Description

An interface for accessing inventory data from a storage server

Definition at line 37 of file IInventoryData.cs.

Member Function Documentation

void OpenSim.Data.IInventoryDataPlugin.addInventoryFolder ( InventoryFolderBase folder )

Adds a new folder specified by folder

Parameters

folder The inventory folder

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.Null.NullInventoryData, and OpenSim.Tests.Common.TestInventoryDataPlugin.

void OpenSim.Data.IInventoryDataPlugin.addInventoryItem ( InventoryItemBase item )

Creates a new inventory item based on item

Parameters

item	The item to be created

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

void OpenSim.Data.IInventoryDataPlugin.deleteInventoryFolder ( UUID folder )

Deletes a folder. Thie will delete both the folder itself and its contents (items and descendent folders)

Parameters

folder The id of the folder

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.Null.NullInventoryData, and OpenSim.Tests.Common.TestInventoryDataPlugin.

void OpenSim.Data.IInventoryDataPlugin.deleteInventoryItem ( UUID item )

Parameters

item

Implemented in OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

List<InventoryItemBase> OpenSim.Data.IInventoryDataPlugin.fetchActiveGestures ( UUID avatarID )

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)

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

List<InventoryFolderBase> OpenSim.Data.IInventoryDataPlugin.getFolderHierarchy ( UUID parentID )

Returns all descendent folders of this folder. Does not return the parent folder itself.

Parameters

parentID The folder to get subfolders for

Returns: A list of inventory folders

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

InventoryFolderBase OpenSim.Data.IInventoryDataPlugin.getInventoryFolder ( UUID folder )

Returns a specified inventory folder by its UUID

Parameters

folder The UUID of the folder to be returned

Returns: A class containing folder information

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

List<InventoryFolderBase> OpenSim.Data.IInventoryDataPlugin.getInventoryFolders ( UUID parentID )

Returns a list of inventory folders contained in the folder 'parentID'

Parameters

parentID The folder to get subfolders for

Returns: A list of inventory folders

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

List<InventoryItemBase> OpenSim.Data.IInventoryDataPlugin.getInventoryInFolder ( UUID folderID )

Returns a list of inventory items contained within the specified folder

Parameters

folderID The UUID of the target folder

Returns: A List of InventoryItemBase items

Implemented in OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

InventoryItemBase OpenSim.Data.IInventoryDataPlugin.getInventoryItem ( UUID item )

Returns an inventory item by its UUID

Parameters

item	The UUID of the item to be returned

Returns: A class containing item information

Implemented in OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

InventoryFolderBase OpenSim.Data.IInventoryDataPlugin.getUserRootFolder ( UUID user )

Returns the users inventory root folder.

Parameters

user	The UUID of the user who is having inventory being returned

Returns: Root inventory folder, null if no root inventory folder was found

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

List<InventoryFolderBase> OpenSim.Data.IInventoryDataPlugin.getUserRootFolders ( UUID user )

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

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

void OpenSim.Data.IInventoryDataPlugin.Initialise ( string connect )

Initialises the interface

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

void OpenSim.Data.IInventoryDataPlugin.moveInventoryFolder ( InventoryFolderBase folder )

Updates a folder based on its ID with folder

Parameters

folder The inventory folder

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.Null.NullInventoryData, and OpenSim.Tests.Common.TestInventoryDataPlugin.

InventoryFolderBase OpenSim.Data.IInventoryDataPlugin.queryInventoryFolder ( UUID folder )

Parameters

item

Implemented in OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.Null.NullInventoryData, and OpenSim.Tests.Common.TestInventoryDataPlugin.

InventoryItemBase OpenSim.Data.IInventoryDataPlugin.queryInventoryItem ( UUID item )

Parameters

item

Implemented in OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

void OpenSim.Data.IInventoryDataPlugin.updateInventoryFolder ( InventoryFolderBase folder )

Updates a folder based on its ID with folder

Parameters

folder The inventory folder

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Data.Null.NullInventoryData, and OpenSim.Tests.Common.TestInventoryDataPlugin.

void OpenSim.Data.IInventoryDataPlugin.updateInventoryItem ( InventoryItemBase item )

Updates an inventory item with item (updates based on ID)

Parameters

item	The updated item

Implemented in OpenSim.Data.MySQL.MySQLInventoryData, OpenSim.Data.PGSQL.PGSQLInventoryData, OpenSim.Tests.Common.TestInventoryDataPlugin, and OpenSim.Data.Null.NullInventoryData.

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

Data/IInventoryData.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation