OpenSim::Data::NHibernate::NHibernateInventoryData Class Reference

Inheritance diagram for OpenSim::Data::NHibernate::NHibernateInventoryData:

List of all members.

Public Member Functions
void	Initialise ()
	Default-initialises the plugin.
void	Initialise (string connect)
	Initialises the interface.
InventoryItemBase	getInventoryItem (UUID item)
	Returns an inventory item by its UUID.
void	addInventoryItem (InventoryItemBase item)
	Creates a new inventory item based on item.
void	updateInventoryItem (InventoryItemBase item)
	Updates an inventory item with item (updates based on ID).
void	deleteInventoryItem (UUID itemID)
InventoryFolderBase	getInventoryFolder (UUID folder)
	Returns an inventory folder by its UUID.
void	addInventoryFolder (InventoryFolderBase folder)
	Creates a new inventory folder based on folder.
void	updateInventoryFolder (InventoryFolderBase folder)
	Updates an inventory folder with folder (updates based on ID).
void	deleteInventoryFolder (UUID folderID)
void	Shutdown ()
void	Dispose ()
	Closes the interface.
void	moveInventoryFolder (InventoryFolderBase folder)
	Updates a folder based on its ID with folder.
void	moveInventoryItem (InventoryItemBase item)
List< InventoryItemBase >	getInventoryInFolder (UUID folderID)
	Returns a list of inventory items contained within the specified folder.
List< InventoryFolderBase >	getUserRootFolders (UUID user)
	Returns a list of the root folders within a users inventory.
InventoryFolderBase	getUserRootFolder (UUID user)
	Returns the users inventory root folder.
List< InventoryFolderBase >	getInventoryFolders (UUID parentID)
	Returns a list of inventory folders contained in the folder 'parentID'.
List< InventoryFolderBase >	getFolderHierarchy (UUID parentID)
	Returns all descendent folders of this folder. Does not return the parent folder itself.
List< InventoryItemBase >	fetchActiveGestures (UUID avatarID)
	Returns all activated gesture-items in the inventory of the specified avatar.
Properties
string	Name [get]
	The plugin being loaded.
string	Version [get]
	The plugins version.

---

Member Function Documentation

void OpenSim::Data::NHibernate::NHibernateInventoryData::Initialise

(

)

[inline]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::Initialise

(

string

connect

)

[inline]

Initialises the interface.

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryItemBase OpenSim::Data::NHibernate::NHibernateInventoryData::getInventoryItem

(

UUID

item

)

[inline]

Returns an inventory item by its UUID.

Parameters:

item

The UUID of the item to be returned

Returns:

A class containing item information

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::addInventoryItem

(

InventoryItemBase

item

)

[inline]

Creates a new inventory item based on item.

Parameters:

item

The item to be created

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::updateInventoryItem

(

InventoryItemBase

item

)

[inline]

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

Parameters:

item

The updated item

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::deleteInventoryItem

(

UUID

itemID

)

[inline]

Parameters:

item

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryFolderBase OpenSim::Data::NHibernate::NHibernateInventoryData::getInventoryFolder

(

UUID

folder

)

[inline]

Returns an inventory folder by its UUID.

Parameters:

folder

The UUID of the folder to be returned

Returns:

A class containing folder information

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::addInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Creates a new inventory folder based on folder.

Parameters:

folder

The folder to be created

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::updateInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Updates an inventory folder with folder (updates based on ID).

Parameters:

folder

The updated folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::deleteInventoryFolder

(

UUID

folderID

)

[inline]

Parameters:

folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::Shutdown

(

)

[inline]

void OpenSim::Data::NHibernate::NHibernateInventoryData::Dispose

(

)

[inline]

Closes the interface.

void OpenSim::Data::NHibernate::NHibernateInventoryData::moveInventoryFolder

(

InventoryFolderBase

folder

)

[inline]

Updates a folder based on its ID with folder.

Parameters:

folder

The inventory folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::NHibernate::NHibernateInventoryData::moveInventoryItem

(

InventoryItemBase

item

)

[inline]

List<InventoryItemBase> OpenSim::Data::NHibernate::NHibernateInventoryData::getInventoryInFolder

(

UUID

folderID

)

[inline]

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

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::NHibernate::NHibernateInventoryData::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::NHibernate::NHibernateInventoryData::getUserRootFolder

(

UUID

user

)

[inline]

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

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::NHibernate::NHibernateInventoryData::getInventoryFolders

(

UUID

parentID

)

[inline]

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

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::NHibernate::NHibernateInventoryData::getFolderHierarchy

(

UUID

parentID

)

[inline]

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

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryItemBase> OpenSim::Data::NHibernate::NHibernateInventoryData::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::NHibernate::NHibernateInventoryData::Name [get]

The plugin being loaded.

Returns:

A string containing the plugin name

Implements OpenSim::Framework::IPlugin.

string OpenSim::Data::NHibernate::NHibernateInventoryData::Version [get]

The plugins version.

Returns:

A string containing the plugin version

Implements OpenSim::Framework::IPlugin.

---

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

• /home/sdague/opensim-docs/OpenSim/Data/NHibernate/NHibernateInventoryData.cs

---