Class Locator

Namespace

Tripous.Data

Assembly

Tripous.Data.dll

Runtime locator.

[TypeStore]
public class Locator

Inheritance

object

Locator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

TypeExtensions.InheritsFrom(object, Type)

Properties

Store

Returns the SQL store to use.

protected virtual SqlStore Store { get; }

Property Value

SqlStore

Methods

CheckRequest(LocatorDef, LocatorRequest)

Checks the specified request and returns an error result if it is invalid.

protected virtual LocatorResult CheckRequest(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

LocatorResult

Execute(LocatorDef, LocatorRequest)

Executes a locator request.

public virtual LocatorResult Execute(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

LocatorResult

GetBaseSql(LocatorDef)

Returns the base SELECT statement.

protected virtual string GetBaseSql(LocatorDef LocatorDef)

Parameters

LocatorDef LocatorDef

Returns

string

GetKeyFieldDef(LocatorDef)

Returns the key field definition.

protected virtual LocatorFieldDef GetKeyFieldDef(LocatorDef LocatorDef)

Parameters

LocatorDef LocatorDef

Returns

LocatorFieldDef

GetKeyWhereSql(LocatorDef, LocatorRequest)

Returns the SQL WHERE clause for a key value.

protected virtual string GetKeyWhereSql(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

string

GetSearchFieldNames(LocatorDef, LocatorRequest)

Returns the search field names to use.

protected virtual List<string> GetSearchFieldNames(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

List<string>

GetSql(LocatorDef, LocatorRequest)

Returns the SELECT statement to execute.

protected virtual string GetSql(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

string

GetSqlResultFields(LocatorDef)

Returns the result field list as SQL text.

protected virtual string GetSqlResultFields(LocatorDef LocatorDef)

Parameters

LocatorDef LocatorDef

Returns

string

GetSqlValue(object, DataFieldType)

Returns a SQL value literal.

protected virtual string GetSqlValue(object Value, DataFieldType DataType)

Parameters

Value object

DataType DataFieldType

Returns

string

GetStatus(LocatorDef, int)

Returns the status for a row count.

protected virtual LocatorResultStatus GetStatus(LocatorDef LocatorDef, int RowCount)

Parameters

LocatorDef LocatorDef

RowCount int

Returns

LocatorResultStatus

GetWhereSql(LocatorDef, LocatorRequest)

Returns the SQL WHERE clause for a search term.

protected virtual string GetWhereSql(LocatorDef LocatorDef, LocatorRequest Request)

Parameters

LocatorDef LocatorDef

Request LocatorRequest

Returns

string

InvalidRequest(string)

Returns an invalid request result.

protected virtual LocatorResult InvalidRequest(string Message)

Parameters

Message string

Returns

LocatorResult

IsSelectSource(string)

Returns true when the specified source is a SELECT statement.

protected virtual bool IsSelectSource(string Source)

Parameters

Source string

Returns

bool