Class ClarifyGeneric

Inheritance

System.Object

FCGeneric

ClarifyGeneric

Implements

System.Collections.ICollection

System.Collections.IEnumerable

System.ComponentModel.IListSource

Inherited Members

FCGeneric.FILTER_LIKE

FCGeneric.FILTER_NOT_LIKE

FCGeneric.FILTER_SOUNDS_LIKE

FCGeneric.FILTER_EQUAL

FCGeneric.FILTER_NOT_EQUAL

FCGeneric.FILTER_LESS_THAN

FCGeneric.FILTER_GREATER_THAN

FCGeneric.FILTER_LESS_THAN_EQUAL

FCGeneric.FILTER_GREATER_THAN_EQUAL

FCGeneric.FILTER_IS_NULL

FCGeneric.FILTER_IS_NOT_NULL

FCGeneric.FILTER_IS_IN

FCGeneric.FILTER_IS_NOT_IN

FCGeneric.EXCLUSIVE_REL_TABLEIDFIELDNAME

FCGeneric.INCLUDE_MTM_PARENT_FIELDNAME

FCGeneric.NOW_DATE

FCGeneric.MIN_DATE

FCGeneric.MAX_DATE

FCGeneric.schemaTable

FCGeneric.ChangeRestrictionGroup(String)

FCGeneric.PerformAddToParentGeneric(FCGeneric, ISchemaRelation)

FCGeneric.ClearRoot()

FCGeneric.BaseTraverseFromRoot(Object, String, String)

FCGeneric.BaseTraverseFromParent(FCGeneric, String)

FCGeneric.Traverse(FCGeneric, String)

FCGeneric.UnTraverse()

FCGeneric.OnMaximumRowsExceeded(Int32, MaximumRowsExceededEventArgs)

FCGeneric.SetTableName(String)

FCGeneric.CloseGeneric()

FCGeneric.AddForUpdate(Object)

FCGeneric.ValidateAddNew()

FCGeneric.BaseDeleteById(Object)

FCGeneric.AppendSort(String, Boolean)

FCGeneric.AppendSort(String, Boolean, Boolean)

FCGeneric.AppendFilter(String, Boolean)

FCGeneric.AppendFilter(String, NumberOps, Int32)

FCGeneric.AppendFilter(String, NumberOps, Decimal)

FCGeneric.AppendFilter(String, DateOps, DateTime)

FCGeneric.AppendFilter(String, StringOps, String)

FCGeneric.AppendFilterBetween(String, Boolean, Int32, Int32)

FCGeneric.AppendFilterBetween(String, Boolean, Decimal, Decimal)

FCGeneric.AppendFilterBetween(String, Boolean, DateTime, DateTime)

FCGeneric.AppendFilterInList(String, Boolean, Int32[])

FCGeneric.AppendFilterInList(String, Boolean, Decimal[])

FCGeneric.AppendFilterInList(String, Boolean, DateTime[])

FCGeneric.AppendFilterInList(String, Boolean, String[])

FCGeneric.AppendFilterIsNull(String, Boolean)

FCGeneric.ClearFilters()

FCGeneric.ClearSorts()

FCGeneric.DeleteAll()

FCGeneric.Update(GenericDataRow)

FCGeneric.Update(GenericDataRow, IDbTransaction)

FCGeneric.Update(GenericDataRow, UpdateQueryBatch)

FCGeneric.UpdateAll()

FCGeneric.UpdateAll(UpdateQueryBatch)

FCGeneric.ProcessBindings(IDictionary<FCGeneric, IDictionary<Guid, GenericDataRow>>, UpdateQueryBatch)

FCGeneric.AssignAllObjIDs(IEnumerable<GenericDataRow>)

FCGeneric.AssignObjID(GenericDataRow)

FCGeneric.CopyTo(Array, Int32)

FCGeneric.GetEnumerator()

FCGeneric.RestrictionGroup

FCGeneric.BaseSession

FCGeneric.BaseDataSet

FCGeneric.BaseSortList

FCGeneric.BaseRootObjectID

FCGeneric.BaseIsTraverseFromRoot

FCGeneric.BaseDataTable

FCGeneric.IsOracleProvider

FCGeneric.DataSetTableName

FCGeneric.BaseRows

FCGeneric.BaseResults

FCGeneric.Bindings

FCGeneric.BaseSchemaTable

FCGeneric.BaseParentGeneric

FCGeneric.ChildGenerics

FCGeneric.BaseChildGenerics

FCGeneric.BaseParentRelation

FCGeneric.Filter

FCGeneric.DeleteRelationsToUnrelate

FCGeneric.MaximumRows

FCGeneric.Count

FCGeneric.TableName

FCGeneric.SetNullStringsToEmpty

FCGeneric.IsDistinct

FCGeneric.RawFilter

FCGeneric.DataFields

FCGeneric.DataRestrictionsEnabled

FCGeneric.IncludeRelations

FCGeneric.QueryEmptyToNull

FCGeneric.IsSynchronized

FCGeneric.SyncRoot

FCGeneric.MaximumRowsExceeded

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: FChoice.Foundation.Clarify

Assembly: fcSDK.dll

Syntax

public class ClarifyGeneric : FCGeneric, ICollection, IEnumerable, IListSource

Constructors

ClarifyGeneric(ClarifyDataSet)

Declaration

protected ClarifyGeneric(ClarifyDataSet parentData)

Parameters

Type	Name	Description
ClarifyDataSet	parentData

ClarifyGeneric(ClarifyDataSet, ClarifyGeneric, String)

Declaration

protected ClarifyGeneric(ClarifyDataSet parentData, ClarifyGeneric parent, string relationName)

Parameters

Type	Name	Description
ClarifyDataSet	parentData
ClarifyGeneric	parent
System.String	relationName

ClarifyGeneric(ClarifyDataSet, Int32, String, String)

Declaration

protected ClarifyGeneric(ClarifyDataSet parentData, int rootObjId, string rootObjName, string relFromParent)

Parameters

Type	Name	Description
ClarifyDataSet	parentData
System.Int32	rootObjId
System.String	rootObjName
System.String	relFromParent

ClarifyGeneric(ClarifyDataSet, String)

Declaration

protected ClarifyGeneric(ClarifyDataSet parentData, string tableName)

Parameters

Type	Name	Description
ClarifyDataSet	parentData
System.String	tableName

Fields

GuidColumnName

Declaration

public static readonly string GuidColumnName

Field Value

Type	Description
System.String

Properties

DataSet

Declaration

public ClarifyDataSet DataSet { get; }

Property Value

Type	Description
ClarifyDataSet

DefaultObjectIdValue

Declaration

protected override object DefaultObjectIdValue { get; }

Property Value

Type	Description
System.Object

Overrides

FCGeneric.DefaultObjectIdValue

Item[Int32]

Declaration

public ClarifyDataRow this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
ClarifyDataRow

Log

Declaration

protected override Logger Log { get; }

Property Value

Type	Description
Logger

Overrides

FCGeneric.Log

ObjectIdFieldName

Declaration

protected override string ObjectIdFieldName { get; }

Property Value

Type	Description
System.String

Overrides

FCGeneric.ObjectIdFieldName

ParentGeneric

Declaration

public ClarifyGeneric ParentGeneric { get; }

Property Value

Type	Description
ClarifyGeneric

ParentRelation

Declaration

public SchemaRelation ParentRelation { get; }

Property Value

Type	Description
SchemaRelation

Results

Declaration

protected ClarifyDataTable Results { get; }

Property Value

Type	Description
ClarifyDataTable

Rows

Declaration

public ClarifyRowCollection Rows { get; }

Property Value

Type	Description
ClarifyRowCollection

SchemaTable

Declaration

public SchemaTableBase SchemaTable { get; }

Property Value

Type	Description
SchemaTableBase

SearchableFieldPrefix

Declaration

public override string SearchableFieldPrefix { get; }

Property Value

Type	Description
System.String

Overrides

FCGeneric.SearchableFieldPrefix

Session

Declaration

public ClarifySession Session { get; }

Property Value

Type	Description
ClarifySession

Methods

AddColumn(DataTable, SchemaRelation)

Declaration

protected DataColumn AddColumn(DataTable dt, SchemaRelation rel)

Parameters

Type	Name	Description
System.Data.DataTable	dt
SchemaRelation	rel

Returns

Type	Description
System.Data.DataColumn

AddColumn(DataTable, ISchemaField)

Declaration

protected DataColumn AddColumn(DataTable dt, ISchemaField field)

Parameters

Type	Name	Description
System.Data.DataTable	dt
ISchemaField	field

Returns

Type	Description
System.Data.DataColumn

AddColumn(DataTable, String)

Declaration

protected DataColumn AddColumn(DataTable dt, string fieldName)

Parameters

Type	Name	Description
System.Data.DataTable	dt
System.String	fieldName

Returns

Type	Description
System.Data.DataColumn

AddForUpdate(Int32)

Declaration

public ClarifyDataRow AddForUpdate(int objId)

Parameters

Type	Name	Description
System.Int32	objId

Returns

Type	Description
ClarifyDataRow

AddNew()

Declaration

public ClarifyDataRow AddNew()

Returns

Type	Description
ClarifyDataRow

AddNew(ClarifyDataRow)

Declaration

public ClarifyDataRow AddNew(ClarifyDataRow rowToDuplicate)

Parameters

Type	Name	Description
ClarifyDataRow	rowToDuplicate

Returns

Type	Description
ClarifyDataRow

AssignAllObjIDs(ClarifyDataRow[])

Declaration

public void AssignAllObjIDs(ClarifyDataRow[] rows)

Parameters

Type	Name	Description
ClarifyDataRow[]	rows

BuildObjIdString(SqlHelper, String, String, Int32[])

Declaration

protected string BuildObjIdString(SqlHelper dbHelper, string fieldName, string format, int[] relatedObjIds)

Parameters

Type	Name	Description
SqlHelper	dbHelper
System.String	fieldName
System.String	format
System.Int32[]	relatedObjIds

Returns

Type	Description
System.String

BuildSortStatement()

Declaration

protected string BuildSortStatement()

Returns

Type	Description
System.String

BuildSortStatement(Boolean)

Declaration

protected string BuildSortStatement(bool includePrefix)

Parameters

Type	Name	Description
System.Boolean	includePrefix

Returns

Type	Description
System.String

CreateEmptyMtmTable(ClarifyGeneric, SchemaRelation)

Declaration

protected ClarifyDataTable CreateEmptyMtmTable(ClarifyGeneric childGeneric, SchemaRelation relation)

Parameters

Type	Name	Description
ClarifyGeneric	childGeneric
SchemaRelation	relation

Returns

Type	Description
ClarifyDataTable

CreateTraversedGeneric(String)

Declaration

protected virtual ClarifyGeneric CreateTraversedGeneric(string relationName)

Parameters

Type	Name	Description
System.String	relationName

Returns

Type	Description
ClarifyGeneric

DeleteById(Int32)

Declaration

public void DeleteById(int objId)

Parameters

Type	Name	Description
System.Int32	objId

GetRelation(ClarifyGeneric, out Boolean, out Boolean)

Declaration

protected ISchemaRelation GetRelation(ClarifyGeneric otherGeneric, out bool thisIsDBParent, out bool thisIsParentGeneric)

Parameters

Type	Name	Description
ClarifyGeneric	otherGeneric
System.Boolean	thisIsDBParent
System.Boolean	thisIsParentGeneric

Returns

Type	Description
ISchemaRelation

GetRelationName(ClarifyGeneric, ClarifyGeneric, ISchemaRelation)

Declaration

protected static string GetRelationName(ClarifyGeneric parentGen, ClarifyGeneric childGen, ISchemaRelation rel)

Parameters

Type	Name	Description
ClarifyGeneric	parentGen
ClarifyGeneric	childGen
ISchemaRelation	rel

Returns

Type	Description
System.String

PerformAddNew()

Declaration

protected override GenericDataRow PerformAddNew()

Returns

Type	Description
GenericDataRow

Overrides

FCGeneric.PerformAddNew()

PerformAssignObjID(GenericDataRow)

Declaration

protected override void PerformAssignObjID(GenericDataRow row)

Parameters

Type	Name	Description
GenericDataRow	row

Overrides

FCGeneric.PerformAssignObjID(GenericDataRow)

PerformDeletes(IDictionary<Guid, GenericDataRow>, UpdateQueryBatch)

Declaration

protected override void PerformDeletes(IDictionary<Guid, GenericDataRow> deletedRows, UpdateQueryBatch batch)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.Guid, GenericDataRow>	deletedRows
UpdateQueryBatch	batch

Overrides

FCGeneric.PerformDeletes(IDictionary<Guid, GenericDataRow>, UpdateQueryBatch)

PerformSetTableName(String)

Declaration

protected override void PerformSetTableName(string value)

Parameters

Type	Name	Description
System.String	value

Overrides

FCGeneric.PerformSetTableName(String)

PerformUpdate(GenericDataRow, UpdateQueryBatch)

Declaration

protected override void PerformUpdate(GenericDataRow row, UpdateQueryBatch batch)

Parameters

Type	Name	Description
GenericDataRow	row
UpdateQueryBatch	batch

Overrides

FCGeneric.PerformUpdate(GenericDataRow, UpdateQueryBatch)

Query()

Declaration

public override void Query()

Overrides

FCGeneric.Query()

Query(IDbTransaction)

Declaration

public override void Query(IDbTransaction transaction)

Parameters

Type	Name	Description
System.Data.IDbTransaction	transaction

Overrides

FCGeneric.Query(IDbTransaction)

RelateGeneric(FCGeneric, ISchemaRelation)

Declaration

protected override void RelateGeneric(FCGeneric childGeneric, ISchemaRelation relation)

Parameters

Type	Name	Description
FCGeneric	childGeneric
ISchemaRelation	relation

Overrides

FCGeneric.RelateGeneric(FCGeneric, ISchemaRelation)

SetupDataTable()

Declaration

protected override void SetupDataTable()

Overrides

FCGeneric.SetupDataTable()

Traverse(String)

Declaration

public ClarifyGeneric Traverse(string relationName)

Parameters

Type	Name	Description
System.String	relationName

Returns

Type	Description
ClarifyGeneric

TraverseFromParent(ClarifyGeneric, String)

Declaration

public void TraverseFromParent(ClarifyGeneric parentGeneric, string relationName)

Parameters

Type	Name	Description
ClarifyGeneric	parentGeneric
System.String	relationName

TraverseFromRoot(Int32, String, String)

Declaration

public void TraverseFromRoot(int rootObjID, string rootObject, string relationName)

Parameters

Type	Name	Description
System.Int32	rootObjID
System.String	rootObject
System.String	relationName

WasRowAdded(GenericDataRow)

Declaration

protected bool WasRowAdded(GenericDataRow row)

Parameters

Type	Name	Description
GenericDataRow	row

Returns

Type	Description
System.Boolean

Implements

System.Collections.ICollection

System.Collections.IEnumerable

System.ComponentModel.IListSource