diff options
author | Adam Frisby | 2007-06-01 23:34:37 +0000 |
---|---|---|
committer | Adam Frisby | 2007-06-01 23:34:37 +0000 |
commit | a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e (patch) | |
tree | bbb2b2468742b6c9b9b077b4aee6b1fd610790d8 /OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs | |
parent | * Zomg inventory server (incomplete shell) (diff) | |
download | opensim-SC_OLD-a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e.zip opensim-SC_OLD-a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e.tar.gz opensim-SC_OLD-a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e.tar.bz2 opensim-SC_OLD-a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e.tar.xz |
* ZOMG Wtf Comments?
* OpenGrid.Framework.Data is now well documented
Diffstat (limited to '')
-rw-r--r-- | OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs b/OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs index b43557d..88e58d6 100644 --- a/OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs +++ b/OpenGridServices/OpenGrid.Framework.Data/InventoryData.cs | |||
@@ -1,3 +1,29 @@ | |||
1 | /* | ||
2 | * Copyright (c) OpenSim project, http://sim.opensecondlife.org/ | ||
3 | * | ||
4 | * Redistribution and use in source and binary forms, with or without | ||
5 | * modification, are permitted provided that the following conditions are met: | ||
6 | * * Redistributions of source code must retain the above copyright | ||
7 | * notice, this list of conditions and the following disclaimer. | ||
8 | * * Redistributions in binary form must reproduce the above copyright | ||
9 | * notice, this list of conditions and the following disclaimer in the | ||
10 | * documentation and/or other materials provided with the distribution. | ||
11 | * * Neither the name of the <organization> nor the | ||
12 | * names of its contributors may be used to endorse or promote products | ||
13 | * derived from this software without specific prior written permission. | ||
14 | * | ||
15 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
16 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
17 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
18 | * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY | ||
19 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
20 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
21 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
22 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
23 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
24 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
25 | * | ||
26 | */ | ||
1 | using System; | 27 | using System; |
2 | using System.Collections.Generic; | 28 | using System.Collections.Generic; |
3 | using System.Text; | 29 | using System.Text; |
@@ -5,27 +31,75 @@ using libsecondlife; | |||
5 | 31 | ||
6 | namespace OpenGrid.Framework.Data | 32 | namespace OpenGrid.Framework.Data |
7 | { | 33 | { |
34 | /// <summary> | ||
35 | /// Inventory Item - contains all the properties associated with an individual inventory piece. | ||
36 | /// </summary> | ||
8 | public class InventoryItemBase | 37 | public class InventoryItemBase |
9 | { | 38 | { |
39 | /// <summary> | ||
40 | /// A UUID containing the ID for the inventory item itself | ||
41 | /// </summary> | ||
10 | public LLUUID inventoryID; | 42 | public LLUUID inventoryID; |
43 | /// <summary> | ||
44 | /// The UUID of the associated asset on the asset server | ||
45 | /// </summary> | ||
11 | public LLUUID assetID; | 46 | public LLUUID assetID; |
47 | /// <summary> | ||
48 | /// This is an enumerated value determining the type of asset (eg Notecard, Sound, Object, etc) | ||
49 | /// </summary> | ||
12 | public int type; | 50 | public int type; |
51 | /// <summary> | ||
52 | /// The folder this item is contained in (NULL_KEY = Inventory Root) | ||
53 | /// </summary> | ||
13 | public LLUUID parentFolderID; | 54 | public LLUUID parentFolderID; |
55 | /// <summary> | ||
56 | /// The owner of this inventory item | ||
57 | /// </summary> | ||
14 | public LLUUID avatarID; | 58 | public LLUUID avatarID; |
59 | /// <summary> | ||
60 | /// The name of the inventory item (must be less than 64 characters) | ||
61 | /// </summary> | ||
15 | public string inventoryName; | 62 | public string inventoryName; |
63 | /// <summary> | ||
64 | /// The description of the inventory item (must be less than 64 characters) | ||
65 | /// </summary> | ||
16 | public string inventoryDescription; | 66 | public string inventoryDescription; |
67 | /// <summary> | ||
68 | /// A mask containing the permissions for the next owner (cannot be enforced) | ||
69 | /// </summary> | ||
17 | public uint inventoryNextPermissions; | 70 | public uint inventoryNextPermissions; |
71 | /// <summary> | ||
72 | /// A mask containing permissions for the current owner (cannot be enforced) | ||
73 | /// </summary> | ||
18 | public uint inventoryCurrentPermissions; | 74 | public uint inventoryCurrentPermissions; |
19 | } | 75 | } |
20 | 76 | ||
77 | /// <summary> | ||
78 | /// A Class for folders which contain users inventory | ||
79 | /// </summary> | ||
21 | public class InventoryFolderBase | 80 | public class InventoryFolderBase |
22 | { | 81 | { |
82 | /// <summary> | ||
83 | /// The name of the folder (64 characters or less) | ||
84 | /// </summary> | ||
23 | public string name; | 85 | public string name; |
86 | /// <summary> | ||
87 | /// The agent who's inventory this is contained by | ||
88 | /// </summary> | ||
24 | public LLUUID agentID; | 89 | public LLUUID agentID; |
90 | /// <summary> | ||
91 | /// The folder this folder is contained in (NULL_KEY for root) | ||
92 | /// </summary> | ||
25 | public LLUUID parentID; | 93 | public LLUUID parentID; |
94 | /// <summary> | ||
95 | /// The UUID for this folder | ||
96 | /// </summary> | ||
26 | public LLUUID folderID; | 97 | public LLUUID folderID; |
27 | } | 98 | } |
28 | 99 | ||
100 | /// <summary> | ||
101 | /// An interface for accessing inventory data from a storage server | ||
102 | /// </summary> | ||
29 | public interface IInventoryData | 103 | public interface IInventoryData |
30 | { | 104 | { |
31 | /// <summary> | 105 | /// <summary> |