Class FCGeneric

Inheritance

System.Object

FCGeneric

ClarifyGeneric

Implements

System.Collections.ICollection

System.Collections.IEnumerable

System.ComponentModel.IListSource

Inherited Members

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

Assembly: fcSDK.dll

Syntax

public abstract class FCGeneric : ICollection, IEnumerable, IListSource

Constructors

FCGeneric(GenericDataSet)

Declaration

protected FCGeneric(GenericDataSet parentDataSet)

Parameters

Type	Name	Description
GenericDataSet	parentDataSet

FCGeneric(GenericDataSet, FCGeneric, String)

Declaration

protected FCGeneric(GenericDataSet parentDataSet, FCGeneric parent, string relationName)

Parameters

Type	Name	Description
GenericDataSet	parentDataSet
FCGeneric	parent
System.String	relationName

FCGeneric(GenericDataSet, Object, String, String)

Declaration

protected FCGeneric(GenericDataSet parentDataSet, object rootObjId, string rootObjName, string relFromParent)

Parameters

Type	Name	Description
GenericDataSet	parentDataSet
System.Object	rootObjId
System.String	rootObjName
System.String	relFromParent

FCGeneric(GenericDataSet, String)

Declaration

protected FCGeneric(GenericDataSet parentDataSet, string tableName)

Parameters

Type	Name	Description
GenericDataSet	parentDataSet
System.String	tableName

Fields

EXCLUSIVE_REL_TABLEIDFIELDNAME

Declaration

protected const string EXCLUSIVE_REL_TABLEIDFIELDNAME = "FCTableIdentifier"

Field Value

Type	Description
System.String

FILTER_EQUAL

Declaration

protected const string FILTER_EQUAL = "="

Field Value

Type	Description
System.String

FILTER_GREATER_THAN

Declaration

protected const string FILTER_GREATER_THAN = ">"

Field Value

Type	Description
System.String

FILTER_GREATER_THAN_EQUAL

Declaration

protected const string FILTER_GREATER_THAN_EQUAL = ">="

Field Value

Type	Description
System.String

FILTER_IS_IN

Declaration

protected const string FILTER_IS_IN = "IN"

Field Value

Type	Description
System.String

FILTER_IS_NOT_IN

Declaration

protected const string FILTER_IS_NOT_IN = "NOT IN"

Field Value

Type	Description
System.String

FILTER_IS_NOT_NULL

Declaration

protected const string FILTER_IS_NOT_NULL = "IS NOT NULL"

Field Value

Type	Description
System.String

FILTER_IS_NULL

Declaration

protected const string FILTER_IS_NULL = "IS NULL"

Field Value

Type	Description
System.String

FILTER_LESS_THAN

Declaration

protected const string FILTER_LESS_THAN = "<"

Field Value

Type	Description
System.String

FILTER_LESS_THAN_EQUAL

Declaration

protected const string FILTER_LESS_THAN_EQUAL = "<="

Field Value

Type	Description
System.String

FILTER_LIKE

Declaration

protected const string FILTER_LIKE = "LIKE"

Field Value

Type	Description
System.String

FILTER_NOT_EQUAL

Declaration

protected const string FILTER_NOT_EQUAL = "<>"

Field Value

Type	Description
System.String

FILTER_NOT_LIKE

Declaration

protected const string FILTER_NOT_LIKE = "NOT LIKE"

Field Value

Type	Description
System.String

FILTER_SOUNDS_LIKE

Declaration

protected const string FILTER_SOUNDS_LIKE = "SOUNDSLIKE"

Field Value

Type	Description
System.String

INCLUDE_MTM_PARENT_FIELDNAME

Declaration

protected const string INCLUDE_MTM_PARENT_FIELDNAME = "mtm_par_objid"

Field Value

Type	Description
System.String

MAX_DATE

Declaration

public static readonly DateTime MAX_DATE

Field Value

Type	Description
System.DateTime

MIN_DATE

Declaration

public static readonly DateTime MIN_DATE

Field Value

Type	Description
System.DateTime

NOW_DATE

Declaration

public static readonly DateTime NOW_DATE

Field Value

Type	Description
System.DateTime

schemaTable

Declaration

protected ISchemaTableBase schemaTable

Field Value

Type	Description
ISchemaTableBase

Properties

BaseChildGenerics

Declaration

protected IList<FCGeneric> BaseChildGenerics { get; }

Property Value

Type	Description
System.Collections.Generic.IList<FCGeneric>

BaseDataSet

Declaration

protected GenericDataSet BaseDataSet { get; }

Property Value

Type	Description
GenericDataSet

BaseDataTable

Declaration

protected GenericDataTable BaseDataTable { get; set; }

Property Value

Type	Description
GenericDataTable

BaseIsTraverseFromRoot

Declaration

protected bool BaseIsTraverseFromRoot { get; }

Property Value

Type	Description
System.Boolean

BaseParentGeneric

Declaration

protected FCGeneric BaseParentGeneric { get; set; }

Property Value

Type	Description
FCGeneric

BaseParentRelation

Declaration

protected ISchemaRelation BaseParentRelation { get; set; }

Property Value

Type	Description
ISchemaRelation

BaseResults

Declaration

protected GenericDataTable BaseResults { get; }

Property Value

Type	Description
GenericDataTable

BaseRootObjectID

Declaration

protected object BaseRootObjectID { get; }

Property Value

Type	Description
System.Object

BaseRows

Declaration

protected GenericDataRowCollection BaseRows { get; }

Property Value

Type	Description
GenericDataRowCollection

BaseSchemaTable

Declaration

protected ISchemaTableBase BaseSchemaTable { get; }

Property Value

Type	Description
ISchemaTableBase

BaseSession

Declaration

protected FCSession BaseSession { get; }

Property Value

Type	Description
FCSession

BaseSortList

Declaration

protected IList<FCGeneric.FCGenericSort> BaseSortList { get; }

Property Value

Type	Description
System.Collections.Generic.IList<FCGeneric.FCGenericSort>

Bindings

Declaration

protected DynamicBindingCollection Bindings { get; }

Property Value

Type	Description
DynamicBindingCollection

ChildGenerics

Declaration

public ICollection<FCGeneric> ChildGenerics { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<FCGeneric>

Count

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

DataFields

Declaration

public DataFieldNameCollection DataFields { get; }

Property Value

Type	Description
DataFieldNameCollection

DataRestrictionsEnabled

Declaration

public bool DataRestrictionsEnabled { get; set; }

Property Value

Type	Description
System.Boolean

DataSetTableName

Declaration

protected string DataSetTableName { get; }

Property Value

Type	Description
System.String

DefaultObjectIdValue

Declaration

protected abstract object DefaultObjectIdValue { get; }

Property Value

Type	Description
System.Object

DeleteRelationsToUnrelate

Declaration

public RelationNameCollection DeleteRelationsToUnrelate { get; }

Property Value

Type	Description
RelationNameCollection

Filter

Declaration

public AndFilter Filter { get; }

Property Value

Type	Description
AndFilter

IncludeRelations

Declaration

public bool IncludeRelations { get; set; }

Property Value

Type	Description
System.Boolean

IsDistinct

Declaration

public bool IsDistinct { get; set; }

Property Value

Type	Description
System.Boolean

IsOracleProvider

Declaration

protected static bool IsOracleProvider { get; }

Property Value

Type	Description
System.Boolean

IsSynchronized

Declaration

public bool IsSynchronized { get; }

Property Value

Type	Description
System.Boolean

Log

Declaration

protected abstract Logger Log { get; }

Property Value

Type	Description
Logger

MaximumRows

Declaration

public int MaximumRows { get; set; }

Property Value

Type	Description
System.Int32

ObjectIdFieldName

Declaration

protected abstract string ObjectIdFieldName { get; }

Property Value

Type	Description
System.String

QueryEmptyToNull

Declaration

public bool QueryEmptyToNull { get; set; }

Property Value

Type	Description
System.Boolean

RawFilter

Declaration

public string RawFilter { get; set; }

Property Value

Type	Description
System.String

RestrictionGroup

Declaration

public RestrictionGroup RestrictionGroup { get; set; }

Property Value

Type	Description
RestrictionGroup

SearchableFieldPrefix

Declaration

public abstract string SearchableFieldPrefix { get; }

Property Value

Type	Description
System.String

SetNullStringsToEmpty

Declaration

public bool SetNullStringsToEmpty { get; set; }

Property Value

Type	Description
System.Boolean

SyncRoot

Declaration

public object SyncRoot { get; }

Property Value

Type	Description
System.Object

TableName

Declaration

public string TableName { get; }

Property Value

Type	Description
System.String

Methods

AddForUpdate(Object)

Declaration

protected GenericDataRow AddForUpdate(object uniqueId)

Parameters

Type	Name	Description
System.Object	uniqueId

Returns

Type	Description
GenericDataRow

AppendFilter(String, DateOps, DateTime)

Declaration

public void AppendFilter(string fieldName, DateOps operation, DateTime value)

Parameters

Type	Name	Description
System.String	fieldName
DateOps	operation
System.DateTime	value

AppendFilter(String, NumberOps, Decimal)

Declaration

public void AppendFilter(string fieldName, NumberOps operation, decimal value)

Parameters

Type	Name	Description
System.String	fieldName
NumberOps	operation
System.Decimal	value

AppendFilter(String, NumberOps, Int32)

Declaration

public void AppendFilter(string fieldName, NumberOps operation, int value)

Parameters

Type	Name	Description
System.String	fieldName
NumberOps	operation
System.Int32	value

AppendFilter(String, StringOps, String)

Declaration

public void AppendFilter(string fieldName, StringOps operation, string value)

Parameters

Type	Name	Description
System.String	fieldName
StringOps	operation
System.String	value

AppendFilter(String, Boolean)

Declaration

public void AppendFilter(string fieldName, bool value)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	value

AppendFilterBetween(String, Boolean, DateTime, DateTime)

Declaration

public void AppendFilterBetween(string fieldName, bool isBetween, DateTime value1, DateTime value2)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isBetween
System.DateTime	value1
System.DateTime	value2

AppendFilterBetween(String, Boolean, Decimal, Decimal)

Declaration

public void AppendFilterBetween(string fieldName, bool isBetween, decimal value1, decimal value2)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isBetween
System.Decimal	value1
System.Decimal	value2

AppendFilterBetween(String, Boolean, Int32, Int32)

Declaration

public void AppendFilterBetween(string fieldName, bool isBetween, int value1, int value2)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isBetween
System.Int32	value1
System.Int32	value2

AppendFilterInList(String, Boolean, DateTime[])

Declaration

public void AppendFilterInList(string fieldName, bool isIn, params DateTime[] list)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isIn
System.DateTime[]	list

AppendFilterInList(String, Boolean, Decimal[])

Declaration

public void AppendFilterInList(string fieldName, bool isIn, params decimal[] list)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isIn
System.Decimal[]	list

AppendFilterInList(String, Boolean, Int32[])

Declaration

public void AppendFilterInList(string fieldName, bool isIn, params int[] list)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isIn
System.Int32[]	list

AppendFilterInList(String, Boolean, String[])

Declaration

public void AppendFilterInList(string fieldName, bool isIn, params string[] list)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isIn
System.String[]	list

AppendFilterIsNull(String, Boolean)

Declaration

public void AppendFilterIsNull(string fieldName, bool isNull)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isNull

AppendSort(String, Boolean)

Declaration

public void AppendSort(string fieldName, bool isAscending)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isAscending

AppendSort(String, Boolean, Boolean)

Declaration

public void AppendSort(string fieldName, bool isAscending, bool checkField)

Parameters

Type	Name	Description
System.String	fieldName
System.Boolean	isAscending
System.Boolean	checkField

AssignAllObjIDs(IEnumerable<GenericDataRow>)

Declaration

protected void AssignAllObjIDs(IEnumerable<GenericDataRow> rows)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<GenericDataRow>	rows

AssignObjID(GenericDataRow)

Declaration

public void AssignObjID(GenericDataRow row)

Parameters

Type	Name	Description
GenericDataRow	row

BaseDeleteById(Object)

Declaration

protected void BaseDeleteById(object uniqueId)

Parameters

Type	Name	Description
System.Object	uniqueId

BaseTraverseFromParent(FCGeneric, String)

Declaration

protected void BaseTraverseFromParent(FCGeneric parentGeneric, string relationName)

Parameters

Type	Name	Description
FCGeneric	parentGeneric
System.String	relationName

BaseTraverseFromRoot(Object, String, String)

Declaration

protected void BaseTraverseFromRoot(object rootObjid, string rootObject, string relFromParent)

Parameters

Type	Name	Description
System.Object	rootObjid
System.String	rootObject
System.String	relFromParent

ChangeRestrictionGroup(String)

Declaration

public void ChangeRestrictionGroup(string groupName)

Parameters

Type	Name	Description
System.String	groupName

ClearFilters()

Declaration

public void ClearFilters()

ClearRoot()

Declaration

protected void ClearRoot()

ClearSorts()

Declaration

public void ClearSorts()

CloseGeneric()

Declaration

protected void CloseGeneric()

CopyTo(Array, Int32)

Declaration

public void CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array
System.Int32	index

DeleteAll()

Declaration

public void DeleteAll()

GetEnumerator()

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

OnMaximumRowsExceeded(Int32, MaximumRowsExceededEventArgs)

Declaration

protected void OnMaximumRowsExceeded(int totalPossibleRows, MaximumRowsExceededEventArgs args)

Parameters

Type	Name	Description
System.Int32	totalPossibleRows
MaximumRowsExceededEventArgs	args

PerformAddNew()

Declaration

protected abstract GenericDataRow PerformAddNew()

Returns

Type	Description
GenericDataRow

PerformAddToParentGeneric(FCGeneric, ISchemaRelation)

Declaration

protected virtual void PerformAddToParentGeneric(FCGeneric parentGeneric, ISchemaRelation rel)

Parameters

Type	Name	Description
FCGeneric	parentGeneric
ISchemaRelation	rel

PerformAssignObjID(GenericDataRow)

Declaration

protected abstract void PerformAssignObjID(GenericDataRow row)

Parameters

Type	Name	Description
GenericDataRow	row

PerformDeletes(IDictionary<Guid, GenericDataRow>, UpdateQueryBatch)

Declaration

protected abstract void PerformDeletes(IDictionary<Guid, GenericDataRow> rows, UpdateQueryBatch batch)

Parameters

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

PerformSetTableName(String)

Declaration

protected abstract void PerformSetTableName(string value)

Parameters

Type	Name	Description
System.String	value

PerformUpdate(GenericDataRow, UpdateQueryBatch)

Declaration

protected abstract void PerformUpdate(GenericDataRow row, UpdateQueryBatch batch)

Parameters

Type	Name	Description
GenericDataRow	row
UpdateQueryBatch	batch

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

Declaration

protected void ProcessBindings(IDictionary<FCGeneric, IDictionary<Guid, GenericDataRow>> changedRows, UpdateQueryBatch batch)

Parameters

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

Query()

Declaration

public abstract void Query()

Query(IDbTransaction)

Declaration

public abstract void Query(IDbTransaction transaction)

Parameters

Type	Name	Description
System.Data.IDbTransaction	transaction

RelateGeneric(FCGeneric, ISchemaRelation)

Declaration

protected abstract void RelateGeneric(FCGeneric childGeneric, ISchemaRelation rel)

Parameters

Type	Name	Description
FCGeneric	childGeneric
ISchemaRelation	rel

SetTableName(String)

Declaration

protected void SetTableName(string value)

Parameters

Type	Name	Description
System.String	value

SetupDataTable()

Declaration

protected abstract void SetupDataTable()

Traverse(FCGeneric, String)

Declaration

protected void Traverse(FCGeneric parentGeneric, string relationName)

Parameters

Type	Name	Description
FCGeneric	parentGeneric
System.String	relationName

UnTraverse()

Declaration

protected void UnTraverse()

Update(GenericDataRow)

Declaration

public void Update(GenericDataRow row)

Parameters

Type	Name	Description
GenericDataRow	row

Update(GenericDataRow, UpdateQueryBatch)

Declaration

public void Update(GenericDataRow row, UpdateQueryBatch batch)

Parameters

Type	Name	Description
GenericDataRow	row
UpdateQueryBatch	batch

Update(GenericDataRow, IDbTransaction)

Declaration

public void Update(GenericDataRow row, IDbTransaction transaction)

Parameters

Type	Name	Description
GenericDataRow	row
System.Data.IDbTransaction	transaction

UpdateAll()

Declaration

public void UpdateAll()

UpdateAll(UpdateQueryBatch)

Declaration

public void UpdateAll(UpdateQueryBatch batch)

Parameters

Type	Name	Description
UpdateQueryBatch	batch

ValidateAddNew()

Declaration

protected void ValidateAddNew()

Events

MaximumRowsExceeded

Declaration

public event MaximumRowsExceededEventHandler MaximumRowsExceeded

Event Type

Type	Description
MaximumRowsExceededEventHandler

Implements

System.Collections.ICollection

System.Collections.IEnumerable

System.ComponentModel.IListSource