OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Services.HypergridService.HGInventoryService Class Reference

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.HGInventoryService:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.HypergridService.HGInventoryService:
Collaboration graph
[legend]

Public Member Functions

 HGInventoryService (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[] GetMultipleFoldersContent (UUID principalID, UUID[] folderID)
 Gets everything (folders and items) inside a folder 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 InventoryItemBase GetItem (InventoryItemBase item)
 Get an item, given by its UUID More...
 
- Public Member Functions inherited from OpenSim.Services.InventoryService.XInventoryService
 XInventoryService (IConfigSource config)
 
 XInventoryService (IConfigSource config, string configName)
 
virtual InventoryCollection GetFolderContent (UUID principalID, UUID folderID)
 Gets everything (folders and items) inside a folder More...
 
virtual List< InventoryItemBaseGetFolderItems (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, bool onlyIfTrash)
 
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[] 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< InventoryItemBaseGetActiveGestures (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
LoadPlugin< T > (string dllName)
 
LoadPlugin< T > (string dllName, Object[] args)
 
LoadPlugin< T > (string dllName, string className, Object[] args)
 
 ServiceBase (IConfigSource config)
 

Additional Inherited Members

- 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)
 
- 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 50 of file HGInventoryService.cs.

Constructor & Destructor Documentation

OpenSim.Services.HypergridService.HGInventoryService.HGInventoryService ( IConfigSource  config,
string  configName 
)
inline

Definition at line 61 of file HGInventoryService.cs.

Member Function Documentation

override bool OpenSim.Services.HypergridService.HGInventoryService.CreateUserInventory ( UUID  user)
inline

Create the entire inventory for a given user

Parameters
user
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 93 of file HGInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGInventoryService.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 227 of file HGInventoryService.cs.

override InventoryFolderBase OpenSim.Services.HypergridService.HGInventoryService.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 144 of file HGInventoryService.cs.

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

Gets the skeleton of the inventory – folders only

Parameters
userId
Returns

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 100 of file HGInventoryService.cs.

override InventoryItemBase OpenSim.Services.HypergridService.HGInventoryService.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 294 of file HGInventoryService.cs.

override InventoryCollection [] OpenSim.Services.HypergridService.HGInventoryService.GetMultipleFoldersContent ( UUID  userID,
UUID[]  folderIDs 
)
inline

Gets everything (folders and items) inside a folder

Parameters
userId
folderIDs
Returns
Inventory content.

Implements OpenSim.Services.Interfaces.IInventoryService.

Definition at line 159 of file HGInventoryService.cs.

override InventoryFolderBase OpenSim.Services.HypergridService.HGInventoryService.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 106 of file HGInventoryService.cs.

override bool OpenSim.Services.HypergridService.HGInventoryService.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 233 of file HGInventoryService.cs.


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