OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Attributes | List of all members
OpenSim.Services.EstateService.EstateDataService Class Reference
Inheritance diagram for OpenSim.Services.EstateService.EstateDataService:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.EstateService.EstateDataService:
Collaboration graph
[legend]

Public Member Functions

 EstateDataService (IConfigSource config)
 
EstateSettings LoadEstateSettings (UUID regionID, bool create)
 Load estate settings for a region. More...
 
EstateSettings LoadEstateSettings (int estateID)
 Load estate settings for an estate ID. More...
 
EstateSettings CreateNewEstate ()
 Create a new estate. More...
 
List< EstateSettingsLoadEstateSettingsAll ()
 Load/Get all estate settings. More...
 
void StoreEstateSettings (EstateSettings es)
 Store estate settings. More...
 
List< int > GetEstates (string search)
 Get estate IDs. More...
 
List< int > GetEstatesAll ()
 Get the IDs of all estates. More...
 
List< int > GetEstatesByOwner (UUID ownerID)
 Get the IDs of all estates owned by the given user. More...
 
bool LinkRegion (UUID regionID, int estateID)
 Link a region to an estate. More...
 
List< UUID > GetRegions (int estateID)
 Get the UUIDs of all the regions in an estate. More...
 
bool DeleteEstate (int estateID)
 Delete an estate 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)
 

Protected Attributes

IEstateDataStore m_database
 

Detailed Description

Definition at line 41 of file EstateDataService.cs.

Constructor & Destructor Documentation

OpenSim.Services.EstateService.EstateDataService.EstateDataService ( IConfigSource  config)
inline

Definition at line 49 of file EstateDataService.cs.

Member Function Documentation

EstateSettings OpenSim.Services.EstateService.EstateDataService.CreateNewEstate ( )
inline

Create a new estate.

Returns
A EstateSettings

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 91 of file EstateDataService.cs.

bool OpenSim.Services.EstateService.EstateDataService.DeleteEstate ( int  estateID)
inline

Delete an estate

Parameters
estateID
Returns
true if the delete succeeded, false otherwise

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 131 of file EstateDataService.cs.

List<int> OpenSim.Services.EstateService.EstateDataService.GetEstates ( string  search)
inline

Get estate IDs.

Parameters
searchName of estate to search for. This is the exact name, no parttern matching is done.
Returns

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 106 of file EstateDataService.cs.

List<int> OpenSim.Services.EstateService.EstateDataService.GetEstatesAll ( )
inline

Get the IDs of all estates.

Returns
An empty list if no estates were found.

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 111 of file EstateDataService.cs.

List<int> OpenSim.Services.EstateService.EstateDataService.GetEstatesByOwner ( UUID  ownerID)
inline

Get the IDs of all estates owned by the given user.

Returns
An empty list if no estates were found.

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 116 of file EstateDataService.cs.

List<UUID> OpenSim.Services.EstateService.EstateDataService.GetRegions ( int  estateID)
inline

Get the UUIDs of all the regions in an estate.

Parameters
estateID
Returns

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 126 of file EstateDataService.cs.

bool OpenSim.Services.EstateService.EstateDataService.LinkRegion ( UUID  regionID,
int  estateID 
)
inline

Link a region to an estate.

Parameters
regionID
estateID
Returns
true if the link succeeded, false otherwise

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 121 of file EstateDataService.cs.

EstateSettings OpenSim.Services.EstateService.EstateDataService.LoadEstateSettings ( UUID  regionID,
bool  create 
)
inline

Load estate settings for a region.

Parameters
regionID
createIf true, then an estate is created if one is not found.
Returns

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 81 of file EstateDataService.cs.

EstateSettings OpenSim.Services.EstateService.EstateDataService.LoadEstateSettings ( int  estateID)
inline

Load estate settings for an estate ID.

Parameters
estateID
Returns

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 86 of file EstateDataService.cs.

List<EstateSettings> OpenSim.Services.EstateService.EstateDataService.LoadEstateSettingsAll ( )
inline

Load/Get all estate settings.

Returns
An empty list if no estates were found.

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 96 of file EstateDataService.cs.

void OpenSim.Services.EstateService.EstateDataService.StoreEstateSettings ( EstateSettings  es)
inline

Store estate settings.

This is also called by EstateSettings.Save()

Parameters
es

Implements OpenSim.Services.Interfaces.IEstateDataService.

Definition at line 101 of file EstateDataService.cs.

Member Data Documentation

IEstateDataStore OpenSim.Services.EstateService.EstateDataService.m_database
protected

Definition at line 47 of file EstateDataService.cs.


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