C# Class Engage.Dnn.Locator.Data.DataProvider

An abstract representation of the data access for Engage: Locator

Show file Open project: EngageSoftware/Engage-Locator

Public Methods

Method	Description
AddAttribute ( int attributeDefinitionId, int locationId, string attributeValue ) : void
AddAttributeDefinition ( int portalId, int locationTypeId, int dataType, string defaultValue, string attributeName, bool required, string validationExpression, int viewOrder, bool visible, int length ) : int
ClearLocations ( int portalId ) : void
ClearTempLocations ( ) : void
CopyData ( ) : string
DeleteAttributeDefinition ( int definitionId ) : void
DeleteComment ( int commentId ) : void
DeleteLocation ( int locationId ) : void
DeleteLocationType ( int locationTypeId ) : void
GetAllLocations ( int portalId, bool approved, string sortColumn, int index, int pageSize ) : DataTable
GetAllLocationsByDistance ( double latitude, double longitude, int radius, int portalId, int locationTypeIds, int pageIndex, int pageSize ) : IDataReader	Gets a list of the locations in the given locationTypeIds, ordered by their distance from the given coordinates
GetAllLocationsByType ( int portalId, int locationTypeIds, int pageIndex, int pageSize ) : IDataReader	Gets a list of the locations in the given locationTypeIds.
GetAttributeDefinition ( int definitionId ) : IDataReader
GetAttributeDefinitionByName ( int locationTypeId, string name ) : IDataReader
GetAttributeDefinitions ( int locationTypeId ) : DataTable
GetAttributeDefinitionsById ( int locationTypeId ) : IDataReader
GetAttributeValues ( int locationId ) : DataTable
GetComment ( int commentId ) : Comment
GetComments ( int locationId, bool approved ) : DataSet
GetCountriesList ( int portalId ) : DataTable
GetEmailByFileId ( int fileId ) : DataTable
GetEngageLocatorTabModules ( int portalId ) : DataTable
GetFilesToImport ( ) : DataTable
GetImportedLocationStatistics ( int portalId ) : DataTable
GetLastImportIndex ( ) : int
GetLatitudeLongitude ( string address, string city ) : DataTable
GetLocation ( int locationId ) : IDataReader
GetLocationType ( int id ) : DataTable
GetLocationTypeCount ( string type ) : int
GetLocationTypeName ( int id ) : DataTable
GetLocationTypes ( ) : DataTable
GetLocations ( int typeId, int portalId ) : DataTable
GetLocationsByCountry ( int countryId, int portalId, int pageIndex, int pageSize ) : IDataReader	Gets the locations in a given country.
GetNClosestLocations ( double latitude, double longitude, int count, int portalId ) : DataTable
GetNewSubmittedComments ( int portalId, bool approved ) : DataTable
GetTabModuleIdByFileId ( int fileId ) : int
InsertComment ( int locationId, string comment, string submittedBy, bool approved ) : void
InsertFileInfo ( int fileId, int userId, int tabModuleId, int portalId, System.DateTime uploadDate, bool succeeded, bool processed ) : void
InsertLocationType ( string locationTypeName ) : int
SaveComment ( Comment comment ) : void
SaveLocation ( Location loc ) : int
SaveTempLocation ( Location loc, bool successful ) : int
UpdateAttribute ( int attributeDefinitionId, int locationId, string attributeValue ) : void
UpdateAttributeDefinition ( int definitionId, int dataType, string defaultValue, string attributeName, bool required, string validationExpression, int viewOrder, bool visible, int length ) : int
UpdateComment ( int locationId, string comment, string submittedBy, bool approved, int userId ) : void
UpdateImportedLocationRow ( int fileId ) : void
UpdateLocation ( Location loc ) : int
UpdateLocationType ( int locationTypeId, string locationTypeName ) : void

Private Methods

Method	Description
GetConnectionString ( ) : string	Gets the configured connection string for this site's data provider.
Instance ( ) : DataProvider

Method Details

AddAttribute() public abstract method

public abstract AddAttribute ( int attributeDefinitionId, int locationId, string attributeValue ) : void
attributeDefinitionId	int
locationId	int
attributeValue	string
return	void

AddAttributeDefinition() public abstract method

public abstract AddAttributeDefinition ( int portalId, int locationTypeId, int dataType, string defaultValue, string attributeName, bool required, string validationExpression, int viewOrder, bool visible, int length ) : int
portalId	int
locationTypeId	int
dataType	int
defaultValue	string
attributeName	string
required	bool
validationExpression	string
viewOrder	int
visible	bool
length	int
return	int

ClearLocations() public abstract method

public abstract ClearLocations ( int portalId ) : void
portalId	int
return	void

ClearTempLocations() public abstract method

public abstract ClearTempLocations ( ) : void
return	void

CopyData() public abstract method

public abstract CopyData ( ) : string
return	string

DeleteAttributeDefinition() public abstract method

public abstract DeleteAttributeDefinition ( int definitionId ) : void
definitionId	int
return	void

DeleteComment() public abstract method

public abstract DeleteComment ( int commentId ) : void
commentId	int
return	void

DeleteLocation() public abstract method

public abstract DeleteLocation ( int locationId ) : void
locationId	int
return	void

DeleteLocationType() public abstract method

public abstract DeleteLocationType ( int locationTypeId ) : void
locationTypeId	int
return	void

GetAllLocations() public abstract method

public abstract GetAllLocations ( int portalId, bool approved, string sortColumn, int index, int pageSize ) : DataTable
portalId	int
approved	bool
sortColumn	string
index	int
pageSize	int
return	System.Data.DataTable

GetAllLocationsByDistance() public abstract method

Gets a list of the locations in the given locationTypeIds, ordered by their distance from the given coordinates

public abstract GetAllLocationsByDistance ( double latitude, double longitude, int radius, int portalId, int locationTypeIds, int pageIndex, int pageSize ) : IDataReader
latitude	double	The latitude of the search location.
longitude	double	The longitude of the search location.
radius	int
portalId	int	The portal ID.
locationTypeIds	int	The IDs of the types of locations to retrieve.
pageIndex	int	Index of the page, or null if not paging.
pageSize	int	Size of the page, or null if not paging.
return	IDataReader

GetAllLocationsByType() public abstract method

Gets a list of the locations in the given locationTypeIds.

public abstract GetAllLocationsByType ( int portalId, int locationTypeIds, int pageIndex, int pageSize ) : IDataReader
portalId	int	The portal ID.
locationTypeIds	int	The IDs of the types of locations to retrieve.
pageIndex	int	Index of the page, or null if not paging.
pageSize	int	Size of the page, or null if not paging.
return	IDataReader

GetAttributeDefinition() public abstract method

public abstract GetAttributeDefinition ( int definitionId ) : IDataReader
definitionId	int
return	IDataReader

GetAttributeDefinitionByName() public abstract method

public abstract GetAttributeDefinitionByName ( int locationTypeId, string name ) : IDataReader
locationTypeId	int
name	string
return	IDataReader

GetAttributeDefinitions() public abstract method

public abstract GetAttributeDefinitions ( int locationTypeId ) : DataTable
locationTypeId	int
return	System.Data.DataTable

GetAttributeDefinitionsById() public abstract method

public abstract GetAttributeDefinitionsById ( int locationTypeId ) : IDataReader
locationTypeId	int
return	IDataReader

GetAttributeValues() public abstract method

public abstract GetAttributeValues ( int locationId ) : DataTable
locationId	int
return	System.Data.DataTable

GetComment() public abstract method

public abstract GetComment ( int commentId ) : Comment
commentId	int
return	Comment

GetComments() public abstract method

public abstract GetComments ( int locationId, bool approved ) : DataSet
locationId	int
approved	bool
return	System.Data.DataSet

GetCountriesList() public abstract method

public abstract GetCountriesList ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetEmailByFileId() public abstract method

public abstract GetEmailByFileId ( int fileId ) : DataTable
fileId	int
return	System.Data.DataTable

GetEngageLocatorTabModules() public abstract method

public abstract GetEngageLocatorTabModules ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetFilesToImport() public abstract method

public abstract GetFilesToImport ( ) : DataTable
return	System.Data.DataTable

GetImportedLocationStatistics() public abstract method

public abstract GetImportedLocationStatistics ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetLastImportIndex() public abstract method

public abstract GetLastImportIndex ( ) : int
return	int

GetLatitudeLongitude() public abstract method

public abstract GetLatitudeLongitude ( string address, string city ) : DataTable
address	string
city	string
return	System.Data.DataTable

GetLocation() public abstract method

public abstract GetLocation ( int locationId ) : IDataReader
locationId	int
return	IDataReader

GetLocationType() public abstract method

public abstract GetLocationType ( int id ) : DataTable
id	int
return	System.Data.DataTable

GetLocationTypeCount() public abstract method

public abstract GetLocationTypeCount ( string type ) : int
type	string
return	int

GetLocationTypeName() public abstract method

public abstract GetLocationTypeName ( int id ) : DataTable
id	int
return	System.Data.DataTable

GetLocationTypes() public abstract method

public abstract GetLocationTypes ( ) : DataTable
return	System.Data.DataTable

GetLocations() public abstract method

public abstract GetLocations ( int typeId, int portalId ) : DataTable
typeId	int
portalId	int
return	System.Data.DataTable

GetLocationsByCountry() public abstract method

Gets the locations in a given country.

public abstract GetLocationsByCountry ( int countryId, int portalId, int pageIndex, int pageSize ) : IDataReader
countryId	int	The country ID.
portalId	int	The portal ID.
pageIndex	int	Index of the page, or null if not paging.
pageSize	int	Size of the page, or null if not paging.
return	IDataReader

GetNClosestLocations() public abstract method

public abstract GetNClosestLocations ( double latitude, double longitude, int count, int portalId ) : DataTable
latitude	double
longitude	double
count	int
portalId	int
return	System.Data.DataTable

GetNewSubmittedComments() public abstract method

public abstract GetNewSubmittedComments ( int portalId, bool approved ) : DataTable
portalId	int
approved	bool
return	System.Data.DataTable

GetTabModuleIdByFileId() public abstract method

public abstract GetTabModuleIdByFileId ( int fileId ) : int
fileId	int
return	int

InsertComment() public abstract method

public abstract InsertComment ( int locationId, string comment, string submittedBy, bool approved ) : void
locationId	int
comment	string
submittedBy	string
approved	bool
return	void

InsertFileInfo() public abstract method

public abstract InsertFileInfo ( int fileId, int userId, int tabModuleId, int portalId, System.DateTime uploadDate, bool succeeded, bool processed ) : void
fileId	int
userId	int
tabModuleId	int
portalId	int
uploadDate	System.DateTime
succeeded	bool
processed	bool
return	void

InsertLocationType() public abstract method

public abstract InsertLocationType ( string locationTypeName ) : int
locationTypeName	string
return	int

SaveComment() public abstract method

public abstract SaveComment ( Comment comment ) : void
comment	Comment
return	void

SaveLocation() public abstract method

public abstract SaveLocation ( Location loc ) : int
loc	Location
return	int

SaveTempLocation() public abstract method

public abstract SaveTempLocation ( Location loc, bool successful ) : int
loc	Location
successful	bool
return	int

UpdateAttribute() public abstract method

public abstract UpdateAttribute ( int attributeDefinitionId, int locationId, string attributeValue ) : void
attributeDefinitionId	int
locationId	int
attributeValue	string
return	void

UpdateAttributeDefinition() public abstract method

public abstract UpdateAttributeDefinition ( int definitionId, int dataType, string defaultValue, string attributeName, bool required, string validationExpression, int viewOrder, bool visible, int length ) : int
definitionId	int
dataType	int
defaultValue	string
attributeName	string
required	bool
validationExpression	string
viewOrder	int
visible	bool
length	int
return	int

UpdateComment() public abstract method

public abstract UpdateComment ( int locationId, string comment, string submittedBy, bool approved, int userId ) : void
locationId	int
comment	string
submittedBy	string
approved	bool
userId	int
return	void

UpdateImportedLocationRow() public abstract method

public abstract UpdateImportedLocationRow ( int fileId ) : void
fileId	int
return	void

UpdateLocation() public abstract method

public abstract UpdateLocation ( Location loc ) : int
loc	Location
return	int

UpdateLocationType() public abstract method

public abstract UpdateLocationType ( int locationTypeId, string locationTypeName ) : void
locationTypeId	int
locationTypeName	string
return	void