Inheritance diagram for OpenSim.Services.InventoryService.XInventoryService:

Collaboration diagram for OpenSim.Services.InventoryService.XInventoryService:

Public Member Functions
	XInventoryService (IConfigSource config)

	XInventoryService (IConfigSource config, string configName)

virtual bool	CreateUserInventory (UUID principalID)
	Create the entire inventory for a given user More...

virtual List< InventoryFolderBase >	GetInventorySkeleton (UUID principalID)
	Gets the skeleton of the inventory – folders only More...

virtual InventoryFolderBase	GetRootFolder (UUID principalID)
	Retrieve the root inventory folder for the given user. More...

virtual InventoryFolderBase	GetFolderForType (UUID principalID, FolderType type)
	Gets the user folder for the given folder-type More...

virtual InventoryCollection	GetFolderContent (UUID principalID, UUID folderID)
	Gets everything (folders and items) inside a folder More...

virtual InventoryCollection[]	GetMultipleFoldersContent (UUID principalID, UUID[] folderIDs)
	Gets everything (folders and items) inside a folder More...

virtual List< InventoryItemBase >	GetFolderItems (UUID principalID, UUID folderID)
	Gets the items inside a folder More...

virtual bool	AddFolder (InventoryFolderBase folder)
	Add a new folder to the user's inventory More...

virtual bool	UpdateFolder (InventoryFolderBase folder)
	Update a folder in the user's inventory More...

virtual bool	MoveFolder (InventoryFolderBase folder)
	Move an inventory folder to a new location More...

virtual bool	DeleteFolders (UUID principalID, List< UUID > folderIDs)
	Delete an item from the user's inventory More...

virtual bool	DeleteFolders (UUID principalID, List< UUID > folderIDs, bool onlyIfTrash)

virtual bool	PurgeFolder (InventoryFolderBase folder)
	Purge an inventory folder of all its items and subfolders. More...

virtual bool	PurgeFolder (InventoryFolderBase folder, bool onlyIfTrash)

virtual bool	AddItem (InventoryItemBase item)
	Add a new item to the user's inventory More...

virtual bool	UpdateItem (InventoryItemBase item)
	Update an item in the user's inventory More...

virtual bool	MoveItems (UUID principalID, List< InventoryItemBase > items)

virtual bool	DeleteItems (UUID principalID, List< UUID > itemIDs)
	Delete an item from the user's inventory More...

virtual InventoryItemBase	GetItem (InventoryItemBase item)
	Get an item, given by its UUID More...

virtual InventoryItemBase[]	GetMultipleItems (UUID userID, UUID[] ids)
	Get multiple items, given by their UUIDs More...

virtual InventoryFolderBase	GetFolder (InventoryFolderBase folder)
	Get a folder, given by its UUID More...

virtual List< InventoryItemBase >	GetActiveGestures (UUID principalID)
	Get the active gestures of the agent. More...

virtual int	GetAssetPermissions (UUID principalID, UUID assetID)
	Get the union of permissions of all inventory items that hold the given assetID. More...

bool	HasInventoryForUser (UUID userID)
	Does the given user have an inventory structure? More...

Public Member Functions inherited from OpenSim.Services.Base.ServiceBase
T	LoadPlugin< T > (string dllName)

T	LoadPlugin< T > (string dllName, Object[] args)

T	LoadPlugin< T > (string dllName, string className, Object[] args)

	ServiceBase (IConfigSource config)

Protected Member Functions
XInventoryFolder	CreateFolder (UUID principalID, UUID parentID, int type, string name)

virtual XInventoryFolder[]	GetSystemFolders (UUID principalID, UUID rootID)

InventoryFolderBase	ConvertToOpenSim (XInventoryFolder folder)

XInventoryFolder	ConvertFromOpenSim (InventoryFolderBase folder)

InventoryItemBase	ConvertToOpenSim (XInventoryItem item)

XInventoryItem	ConvertFromOpenSim (InventoryItemBase item)

Protected Attributes
IXInventoryData	m_Database

bool	m_AllowDelete = true

string	m_ConfigName = "InventoryService"

Detailed Description

Definition at line 41 of file XInventoryService.cs.

Constructor & Destructor Documentation

OpenSim.Services.InventoryService.XInventoryService.XInventoryService ( IConfigSource config )

inline

Definition at line 51 of file XInventoryService.cs.

OpenSim.Services.InventoryService.XInventoryService.XInventoryService	(	IConfigSource	config,
		string	configName
	)

inline

Definition at line 56 of file XInventoryService.cs.

Member Function Documentation

virtual bool OpenSim.Services.InventoryService.XInventoryService.AddFolder ( InventoryFolderBase folder )

inlinevirtual

Add a new folder to the user's inventory

Parameters

folder

Returns: true if the folder was successfully added

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 358 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.AddItem ( InventoryItemBase item )

inlinevirtual

Add a new item to the user's inventory

Parameters

item	The item to be added. If item.FolderID == UUID.Zero then the item is added to the most suitable system folder. If there is no suitable folder then the item is added to the user's root inventory folder.

Returns: true if the item was successfully added, false if it was not

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 498 of file XInventoryService.cs.

XInventoryFolder OpenSim.Services.InventoryService.XInventoryService.ConvertFromOpenSim ( InventoryFolderBase folder )

inlineprotected

Definition at line 686 of file XInventoryService.cs.

XInventoryItem OpenSim.Services.InventoryService.XInventoryService.ConvertFromOpenSim ( InventoryItemBase item )

inlineprotected

Definition at line 731 of file XInventoryService.cs.

InventoryFolderBase OpenSim.Services.InventoryService.XInventoryService.ConvertToOpenSim ( XInventoryFolder folder )

inlineprotected

Definition at line 669 of file XInventoryService.cs.

InventoryItemBase OpenSim.Services.InventoryService.XInventoryService.ConvertToOpenSim ( XInventoryItem item )

inlineprotected

Definition at line 700 of file XInventoryService.cs.

XInventoryFolder OpenSim.Services.InventoryService.XInventoryService.CreateFolder	(	UUID	principalID,
		UUID	parentID,
		int	type,
		string	name
	)

inlineprotected

Definition at line 160 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.CreateUserInventory ( UUID user )

inlinevirtual

Create the entire inventory for a given user

Parameters

user

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 102 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.DeleteFolders	(	UUID	userID,
		List< UUID >	folderIDs
	)

inlinevirtual

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 444 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.DeleteFolders	(	UUID	principalID,
		List< UUID >	folderIDs,
		bool	onlyIfTrash
	)

inlinevirtual

Definition at line 449 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.DeleteItems	(	UUID	userID,
		List< UUID >	itemIDs
	)

inlinevirtual

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 570 of file XInventoryService.cs.

virtual List<InventoryItemBase> OpenSim.Services.InventoryService.XInventoryService.GetActiveGestures ( UUID userId )

inlinevirtual

Get the active gestures of the agent.

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 640 of file XInventoryService.cs.

virtual int OpenSim.Services.InventoryService.XInventoryService.GetAssetPermissions	(	UUID	userID,
		UUID	assetID
	)

inlinevirtual

Get the union of permissions of all inventory items that hold the given assetID.

Parameters

userID
assetID

Returns: The permissions or 0 if no such asset is found in the user's inventory

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 655 of file XInventoryService.cs.

virtual InventoryFolderBase OpenSim.Services.InventoryService.XInventoryService.GetFolder ( InventoryFolderBase folder )

inlinevirtual

Get a folder, given by its UUID

Parameters

folder

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 628 of file XInventoryService.cs.

virtual InventoryCollection OpenSim.Services.InventoryService.XInventoryService.GetFolderContent	(	UUID	userID,
		UUID	folderID
	)

inlinevirtual

Gets everything (folders and items) inside a folder

Parameters

userId
folderID

Returns: Inventory content. null if the request failed.

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 286 of file XInventoryService.cs.

virtual InventoryFolderBase OpenSim.Services.InventoryService.XInventoryService.GetFolderForType	(	UUID	userID,
		FolderType	type
	)

inlinevirtual

Gets the user folder for the given folder-type

Parameters

userID
type

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 244 of file XInventoryService.cs.

virtual List<InventoryItemBase> OpenSim.Services.InventoryService.XInventoryService.GetFolderItems	(	UUID	userID,
		UUID	folderID
	)

inlinevirtual

Gets the items inside a folder

Parameters

userID
folderID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 340 of file XInventoryService.cs.

virtual List<InventoryFolderBase> OpenSim.Services.InventoryService.XInventoryService.GetInventorySkeleton ( UUID userId )

inlinevirtual

Gets the skeleton of the inventory – folders only

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 199 of file XInventoryService.cs.

virtual InventoryItemBase OpenSim.Services.InventoryService.XInventoryService.GetItem ( InventoryItemBase item )

inlinevirtual

Get an item, given by its UUID

Parameters

item

Returns: null if no item was found, otherwise the found item

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 601 of file XInventoryService.cs.

virtual InventoryCollection [] OpenSim.Services.InventoryService.XInventoryService.GetMultipleFoldersContent	(	UUID	userID,
		UUID[]	folderIDs
	)

inlinevirtual

Gets everything (folders and items) inside a folder

Parameters

userId
folderIDs

Returns: Inventory content.

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 330 of file XInventoryService.cs.

virtual InventoryItemBase [] OpenSim.Services.InventoryService.XInventoryService.GetMultipleItems	(	UUID	userID,
		UUID[]	ids
	)

inlinevirtual

Get multiple items, given by their UUIDs

Parameters

item

Returns: null if no item was found, otherwise the found item

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 613 of file XInventoryService.cs.

virtual InventoryFolderBase OpenSim.Services.InventoryService.XInventoryService.GetRootFolder ( UUID userID )

inlinevirtual

Retrieve the root inventory folder for the given user.

Parameters

userID

Returns: null if no root folder was found

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 219 of file XInventoryService.cs.

virtual XInventoryFolder [] OpenSim.Services.InventoryService.XInventoryService.GetSystemFolders	(	UUID	principalID,
		UUID	rootID
	)

inlineprotectedvirtual

Definition at line 176 of file XInventoryService.cs.

bool OpenSim.Services.InventoryService.XInventoryService.HasInventoryForUser ( UUID userID )

inline

Does the given user have an inventory structure?

Parameters

userID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 662 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.MoveFolder ( InventoryFolderBase folder )

inlinevirtual

Move an inventory folder to a new location

Parameters

folder A folder containing the details of the new location

Returns: true if the folder was successfully moved

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 437 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.MoveItems	(	UUID	principalID,
		List< InventoryItemBase >	items
	)

inlinevirtual

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 558 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.PurgeFolder ( InventoryFolderBase folder )

inlinevirtual

Purge an inventory folder of all its items and subfolders.

Parameters

folder

Returns: true if the folder was successfully purged

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService, and OpenSim.Services.HypergridService.HGInventoryService.

Definition at line 470 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.PurgeFolder	(	InventoryFolderBase	folder,
		bool	onlyIfTrash
	)

inlinevirtual

Definition at line 475 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.UpdateFolder ( InventoryFolderBase folder )

inlinevirtual

Update a folder in the user's inventory

Parameters

folder

Returns: true if the folder was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 400 of file XInventoryService.cs.

virtual bool OpenSim.Services.InventoryService.XInventoryService.UpdateItem ( InventoryItemBase item )

inlinevirtual

Update an item in the user's inventory

Parameters

item

Returns: true if the item was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Reimplemented in OpenSim.Services.HypergridService.HGSuitcaseInventoryService.

Definition at line 506 of file XInventoryService.cs.

Member Data Documentation

bool OpenSim.Services.InventoryService.XInventoryService.m_AllowDelete = true

protected

Definition at line 48 of file XInventoryService.cs.

string OpenSim.Services.InventoryService.XInventoryService.m_ConfigName = "InventoryService"

protected

Definition at line 49 of file XInventoryService.cs.

IXInventoryData OpenSim.Services.InventoryService.XInventoryService.m_Database

protected

Definition at line 47 of file XInventoryService.cs.

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

Services/InventoryService/XInventoryService.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation