Show / Hide Table of Contents

Class LoginRow.CustomSearch

Class representing a custom search against table 'login'. Use this class to create a query that is pre-populated with the correct LoginTableInfo and return fields; you can then add your own restrictions and other clauses to the query. The result will be a LoginRow. If your query matches more than one row in the database, the result will reflect the first row only.

Inheritance
Object
SqlCommand
PrivateSelect
IdxBase
IdxBase<LoginTableInfo>
LoginRow.LoginRowIdxBase
LoginRow.LoginRowIdx
LoginRow.CustomSearch
Implements
ICloneable
ISentryIgnorable
Inherited Members
LoginRow.LoginRowIdxBase.ToLoginRow()
LoginRow.LoginRowIdxBase.ToLoginRow(ITableRowLoadHandler)
LoginRow.LoginRowIdxBase.ToLoginRows()
LoginRow.LoginRowIdxBase.ToLoginRows(ITableRowLoadHandlerFactory)
LoginRow.LoginRowIdxBase.LoginTableInfo
IdxBase<LoginTableInfo>.TableInfo
IdxBase.OnIndexChanged()
IdxBase.BeginIgnoreSentryCheck()
IdxBase.EndIgnoreSentryCheck()
IdxBase.InnerGroupBy
IdxBase.InnerJoinRestriction
IdxBase.InnerReturnFields
IdxBase.JoinRestriction
IdxBase.ReturnFields
IdxBase.IsSentryIgnored
PrivateSelect._isDistinct
PrivateSelect.GetTableInfos()
PrivateSelect.GetRelations(TableInfo)
PrivateSelect.GetRelations(TableInfo, SoTable)
PrivateSelect.IsTableOuterJoined(TableInfo)
PrivateSelect.GetTablesInOrderBy()
PrivateSelect.GetTablesLeadingToTable(TableInfo)
PrivateSelect.ValidateJoin()
PrivateSelect.Clone()
PrivateSelect.CloneSelect()
PrivateSelect.ToString()
PrivateSelect.GetCachingHash()
PrivateSelect.GetRestrictionTables()
PrivateSelect.CreateOrderBy()
PrivateSelect.IsDistinct
PrivateSelect.ForceRecompile
PrivateSelect.ForceJoinOrder
PrivateSelect.SqlType
SqlCommand.Origin
SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)
SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.ClearIgnoreAutoSentryTableInfos()
SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)
SqlCommand.GetPrivateSaves()
SqlCommand.GetInserts()
SqlCommand.GetUpdates()
SqlCommand.GetDeletes()
SqlCommand.GetSelect()
SqlCommand.AutoSentryIgnoredTables
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public sealed class CustomSearch : LoginRow.LoginRowIdx, ICloneable, ISentryIgnorable
Examples

This example shows how a custom search is created, one restriction added, and the search executed.

LoginRow.CustomSearch mySearch = new LoginRow.CustomSearch();
mySearch.Restriction = (some relevant restriction);
LoginRow myRow = LoginRow.GetFromCustomSearch( mySearch );		// query executed here

Constructors

CustomSearch()

Constructor for class LoginRows.CustomSearch. This class represents a custom search against table 'login'.

Declaration
public CustomSearch()
Remarks

By adding restrictions and order by information, a custom query can be formatted against the database.
If this is not added, all the rows in the table are returned.

Properties

InnerOrderBy

Implementation of the OrderBy clause.

Declaration
protected override OrderBy InnerOrderBy { get; }
Property Value
Type Description
OrderBy
Overrides
IdxBase.InnerOrderBy

InnerRestriction

Restriction (e.g. sql: WHERE) for the select statement.

Declaration
protected override Restriction InnerRestriction { get; }
Property Value
Type Description
Restriction

RestrictionObject holding the restrictions for the select statement.

Overrides
PrivateSelect.InnerRestriction

OrderBy

Implementation of the OrderBy clause.

Declaration
public OrderBy OrderBy { get; }
Property Value
Type Description
OrderBy

Restriction

Restriction (e.g. sql: WHERE) for the select statement.

Declaration
public Restriction Restriction { get; set; }
Property Value
Type Description
Restriction

RestrictionObject holding the restrictions for the select statement.

Methods

RestrictionAnd(Restriction)

Calling this method is equivalent to the statement Restriction = Restriction.And( <argument> ), including protection against null Restrictions. Use it as a convenient shorthand if you are building complex restrictions out of smaller parts.

Declaration
public void RestrictionAnd(Restriction rightHandSide)
Parameters
Type Name Description
Restriction rightHandSide

The right-hand side of the AND, the left-hand side is this objects' current Restriction.

RestrictionOr(Restriction)

Calling this method is equivalent to the statement Restriction = Restriction.Or( <argument> ), including protection against null Restrictions. Use it as a convenient shorthand if you are building complex restrictions out of smaller parts.

Declaration
public void RestrictionOr(Restriction rightHandSide)
Parameters
Type Name Description
Restriction rightHandSide

The right-hand side of the OR, the left-hand side is this objects' current Restriction.

UpdateRow(TableRowBase)

Update the LoginRow with the values from the index.

Declaration
public override void UpdateRow(TableRowBase row)
Parameters
Type Name Description
TableRowBase row

The row to update. This must be an instance of LoginRow.

Overrides
IdxBase.UpdateRow(TableRowBase)
Remarks

This method does nothing for a the CustomSearch class.

Implements

System.ICloneable
ISentryIgnorable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)
QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)
QueryExectionExtensions.ExecuteNonQuery(SqlCommand)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top