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
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public sealed class CustomSearch : LoginRow.LoginRowIdx, ICloneable, ISentryIgnorableExamples
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 hereConstructors
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.
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 hereProperties
InnerOrderBy
Implementation of the OrderBy clause.
Declaration
protected override OrderBy InnerOrderBy { get; }Property Value
| Type | Description |
|---|---|
| OrderBy |
Overrides
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 hereInnerRestriction
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
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 hereOrderBy
Implementation of the OrderBy clause.
Declaration
public OrderBy OrderBy { get; }Property Value
| Type | Description |
|---|---|
| OrderBy |
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 hereRestriction
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. |
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 hereMethods
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. |
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 hereRestrictionOr(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. |
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 hereUpdateRow(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
Remarks
This method does nothing for a the CustomSearch class.
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