C# Class Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderImpl

Inheritance: InventoryFolderBase
ファイルを表示 Open project: Virtual-Universe/Virtual-Universe Class Usage Examples

Public Properties

Property Type Description
Items InventoryItemBase>.Dictionary
PATH_DELIMITER string

Public Methods

Method Description
AddChildFolder ( InventoryFolderImpl folder ) : void

Add a folder that already exists.

ContainsChildFolder ( UUID folderID ) : bool

Does this folder contain the given child folder?

CreateChildFolder ( UUID folderID, string folderName, ushort type ) : InventoryFolderImpl

Create a new subfolder.

DeleteItem ( UUID itemID ) : bool

Deletes an item if it exists in this folder or any children

FindAsset ( UUID assetID ) : InventoryItemBase
FindFolder ( UUID folderID ) : InventoryFolderImpl

Returns the folder requested if it is this folder or is a descendent of this folder. The search is depth first.

FindFolderByPath ( string path ) : InventoryFolderImpl

Find a folder given a PATH_DELIMITER delimited path starting from this folder

FindFolderForType ( short type ) : InventoryFolderImpl

Look through all child subfolders for a folder marked as one for a particular folder type, and return it.

FindItem ( UUID itemID ) : InventoryItemBase

Returns the item if it exists in this folder or in any of this folder's descendant folders

FindItemByPath ( string path ) : InventoryItemBase

Find an item given a PATH_DELIMITOR delimited path starting from this folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.

GetChildFolder ( UUID folderID ) : InventoryFolderImpl

Get a child folder

InventoryFolderImpl ( ) : System
InventoryFolderImpl ( InventoryFolderBase folderbase ) : System
Purge ( ) : void

Delete all the folders and items in this folder.

RemoveChildFolder ( UUID folderID ) : InventoryFolderImpl

Removes the given child subfolder.

RequestListOfFolderImpls ( ) : List
RequestListOfFolders ( ) : List

Return a copy of the list of child folders in this folder. The folders themselves are the originals.

RequestListOfItems ( ) : List

Return a copy of the list of child items in this folder. The items themselves are the originals.

Method Details

AddChildFolder() public method

Add a folder that already exists.
public AddChildFolder ( InventoryFolderImpl folder ) : void
folder InventoryFolderImpl
return void

ContainsChildFolder() public method

Does this folder contain the given child folder?
public ContainsChildFolder ( UUID folderID ) : bool
folderID UUID
return bool

CreateChildFolder() public method

Create a new subfolder.
public CreateChildFolder ( UUID folderID, string folderName, ushort type ) : InventoryFolderImpl
folderID UUID
folderName string
type ushort
return InventoryFolderImpl

DeleteItem() public method

Deletes an item if it exists in this folder or any children
public DeleteItem ( UUID itemID ) : bool
itemID UUID
return bool

FindAsset() public method

public FindAsset ( UUID assetID ) : InventoryItemBase
assetID UUID
return InventoryItemBase

FindFolder() public method

Returns the folder requested if it is this folder or is a descendent of this folder. The search is depth first.
public FindFolder ( UUID folderID ) : InventoryFolderImpl
folderID UUID
return InventoryFolderImpl

FindFolderByPath() public method

Find a folder given a PATH_DELIMITER delimited path starting from this folder
public FindFolderByPath ( string path ) : InventoryFolderImpl
path string /// The path to the required folder. /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned. ///
return InventoryFolderImpl

FindFolderForType() public method

Look through all child subfolders for a folder marked as one for a particular folder type, and return it.
public FindFolderForType ( short type ) : InventoryFolderImpl
type short
return InventoryFolderImpl

FindItem() public method

Returns the item if it exists in this folder or in any of this folder's descendant folders
public FindItem ( UUID itemID ) : InventoryItemBase
itemID UUID
return InventoryItemBase

FindItemByPath() public method

Find an item given a PATH_DELIMITOR delimited path starting from this folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.
public FindItemByPath ( string path ) : InventoryItemBase
path string /// The path to the required item. ///
return InventoryItemBase

GetChildFolder() public method

Get a child folder
public GetChildFolder ( UUID folderID ) : InventoryFolderImpl
folderID UUID
return InventoryFolderImpl

InventoryFolderImpl() public method

public InventoryFolderImpl ( ) : System
return System

InventoryFolderImpl() public method

public InventoryFolderImpl ( InventoryFolderBase folderbase ) : System
folderbase InventoryFolderBase
return System

Purge() public method

Delete all the folders and items in this folder.
public Purge ( ) : void
return void

RemoveChildFolder() public method

Removes the given child subfolder.
public RemoveChildFolder ( UUID folderID ) : InventoryFolderImpl
folderID UUID
return InventoryFolderImpl

RequestListOfFolderImpls() public method

public RequestListOfFolderImpls ( ) : List
return List

RequestListOfFolders() public method

Return a copy of the list of child folders in this folder. The folders themselves are the originals.
public RequestListOfFolders ( ) : List
return List

RequestListOfItems() public method

Return a copy of the list of child items in this folder. The items themselves are the originals.
public RequestListOfItems ( ) : List
return List

Property Details

Items public_oe property

Items that are contained in this folder
public Dictionary Items
return InventoryItemBase>.Dictionary

PATH_DELIMITER public_oe static_oe property

public static string PATH_DELIMITER
return string