Hypergrid inventory service. It serves the IInventoryService interface, but implements it in ways that are appropriate for inter-grid inventory exchanges. Specifically, it does not performs deletions and it responds to GetRootFolder requests with the ID of the Suitcase folder, not the actual "My Inventory" folder. More...

Inheritance diagram for OpenSim.Services.HypergridService.HGSuitcaseInventoryService:

[legend]

Collaboration diagram for OpenSim.Services.HypergridService.HGSuitcaseInventoryService:

[legend]

Public Member Functions
	HGSuitcaseInventoryService (IConfigSource config, string configName)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from OpenSim.Services.InventoryService.XInventoryService
	XInventoryService (IConfigSource config)

	XInventoryService (IConfigSource config, string configName)

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

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

virtual bool	PurgeFolder (InventoryFolderBase folder, bool onlyIfTrash)

virtual InventoryItemBase[]	GetMultipleItems (UUID userID, UUID[] ids)
	Get multiple items, given by their UUIDs 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
void	CreateSystemFolders (UUID principalID, UUID rootID)

Protected Member Functions inherited from OpenSim.Services.InventoryService.XInventoryService
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)

Additional Inherited Members
Protected Attributes inherited from OpenSim.Services.InventoryService.XInventoryService
IXInventoryData	m_Database

bool	m_AllowDelete = true

string	m_ConfigName = "InventoryService"

Detailed Description

Hypergrid inventory service. It serves the IInventoryService interface, but implements it in ways that are appropriate for inter-grid inventory exchanges. Specifically, it does not performs deletions and it responds to GetRootFolder requests with the ID of the Suitcase folder, not the actual "My Inventory" folder.

Definition at line 51 of file HGSuitcaseInventoryService.cs.

Constructor & Destructor Documentation

OpenSim.Services.HypergridService.HGSuitcaseInventoryService.HGSuitcaseInventoryService	(	IConfigSource	config,
		string	configName
	)

inline

Definition at line 66 of file HGSuitcaseInventoryService.cs.

Member Function Documentation

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.AddFolder ( InventoryFolderBase folder )

inline

Add a new folder to the user's inventory

Parameters

folder

Returns: true if the folder was successfully added

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 276 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.AddItem ( InventoryItemBase item )

inline

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.

Definition at line 343 of file HGSuitcaseInventoryService.cs.

void OpenSim.Services.HypergridService.HGSuitcaseInventoryService.CreateSystemFolders	(	UUID	principalID,
		UUID	rootID
	)

inlineprotected

Definition at line 176 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.CreateUserInventory ( UUID user )

inline

Create the entire inventory for a given user

Parameters

user

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 108 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.DeleteFolders	(	UUID	userID,
		List< UUID >	folderIDs
	)

inline

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 331 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.DeleteItems	(	UUID	userID,
		List< UUID >	itemIDs
	)

inline

Delete an item from the user's inventory

Parameters

item

Returns: true if the item was successfully deleted

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 397 of file HGSuitcaseInventoryService.cs.

new InventoryFolderBase OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetFolder ( InventoryFolderBase folder )

inline

Get a folder, given by its UUID

Parameters

folder

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 429 of file HGSuitcaseInventoryService.cs.

override InventoryCollection OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetFolderContent	(	UUID	userID,
		UUID	folderID
	)

inline

Gets everything (folders and items) inside a folder

Parameters

userId
folderID

Returns: Inventory content. null if the request failed.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 243 of file HGSuitcaseInventoryService.cs.

override InventoryFolderBase OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetFolderForType	(	UUID	userID,
		FolderType	type
	)

inline

Gets the user folder for the given folder-type

Parameters

userID
type

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 215 of file HGSuitcaseInventoryService.cs.

override List<InventoryItemBase> OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetFolderItems	(	UUID	userID,
		UUID	folderID
	)

inline

Gets the items inside a folder

Parameters

userID
folderID

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 263 of file HGSuitcaseInventoryService.cs.

override List<InventoryFolderBase> OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetInventorySkeleton ( UUID userId )

inline

Gets the skeleton of the inventory – folders only

Parameters

userId

Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 114 of file HGSuitcaseInventoryService.cs.

new InventoryItemBase OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetItem ( InventoryItemBase item )

inline

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.

Definition at line 402 of file HGSuitcaseInventoryService.cs.

override InventoryFolderBase OpenSim.Services.HypergridService.HGSuitcaseInventoryService.GetRootFolder ( UUID userID )

inline

Retrieve the root inventory folder for the given user.

Parameters

userID

Returns: null if no root folder was found

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 140 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.MoveFolder ( InventoryFolderBase folder )

inline

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.

Definition at line 314 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.MoveItems	(	UUID	principalID,
		List< InventoryItemBase >	items
	)

inline

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 369 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.PurgeFolder ( InventoryFolderBase folder )

inline

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.

Definition at line 337 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.UpdateFolder ( InventoryFolderBase folder )

inline

Update a folder in the user's inventory

Parameters

folder

Returns: true if the folder was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 301 of file HGSuitcaseInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGSuitcaseInventoryService.UpdateItem ( InventoryItemBase item )

inline

Update an item in the user's inventory

Parameters

item

Returns: true if the item was successfully updated

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 358 of file HGSuitcaseInventoryService.cs.

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

Services/HypergridService/HGSuitcaseInventoryService.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation