OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Data.IEstateDataStore Interface Reference
Inheritance diagram for OpenSim.Data.IEstateDataStore:
Inheritance graph
[legend]

Public Member Functions

void Initialise (string connectstring)
 Initialise the data store. More...
 
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 > GetEstatesByOwner (UUID ownerID)
 Get the IDs of all estates owned by the given user. More...
 
List< int > GetEstatesAll ()
 Get the IDs of all estates. 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...
 

Detailed Description

Definition at line 34 of file IEstateDataStore.cs.

Member Function Documentation

EstateSettings OpenSim.Data.IEstateDataStore.CreateNewEstate ( )
bool OpenSim.Data.IEstateDataStore.DeleteEstate ( int  estateID)

Delete an estate

Parameters
estateID
Returns
true if the delete succeeded, false otherwise

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

List<int> OpenSim.Data.IEstateDataStore.GetEstates ( string  search)

Get estate IDs.

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

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

List<int> OpenSim.Data.IEstateDataStore.GetEstatesAll ( )

Get the IDs of all estates.

Returns
An empty list if no estates were found.

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, and OpenSim.Data.Null.NullEstateStore.

List<int> OpenSim.Data.IEstateDataStore.GetEstatesByOwner ( UUID  ownerID)

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

Returns
An empty list if no estates were found.

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

List<UUID> OpenSim.Data.IEstateDataStore.GetRegions ( int  estateID)

Get the UUIDs of all the regions in an estate.

Parameters
estateID
Returns

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

void OpenSim.Data.IEstateDataStore.Initialise ( string  connectstring)
bool OpenSim.Data.IEstateDataStore.LinkRegion ( UUID  regionID,
int  estateID 
)

Link a region to an estate.

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

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

EstateSettings OpenSim.Data.IEstateDataStore.LoadEstateSettings ( UUID  regionID,
bool  create 
)

Load estate settings for a region.

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

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

EstateSettings OpenSim.Data.IEstateDataStore.LoadEstateSettings ( int  estateID)

Load estate settings for an estate ID.

Parameters
estateID
Returns

Implemented in OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

List<EstateSettings> OpenSim.Data.IEstateDataStore.LoadEstateSettingsAll ( )

Load/Get all estate settings.

Returns
An empty list if no estates were found.

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.

void OpenSim.Data.IEstateDataStore.StoreEstateSettings ( EstateSettings  es)

Store estate settings.

This is also called by EstateSettings.Save()

Parameters
es

Implemented in OpenSim.Data.PGSQL.PGSQLEstateStore, OpenSim.Data.MySQL.MySQLEstateStore, OpenSim.Data.SQLite.SQLiteEstateStore, and OpenSim.Data.Null.NullEstateStore.


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