Show / Hide Table of Contents

ClarifyGeneric Class Members

The following tables list the members exposed by ClarifyGeneric.

Public Fields

  Name Description
Public Fieldstatic (Shared in Visual Basic) GuidColumnName  

Public Properties

  Name Description
Public Property ChildGenerics Gets an IDictionary of associated child generics keyed by their relation from the parent (Inherited from FChoice.Foundation.FCGeneric)
Public Property Count Returns the number of rows currently populated by the Query or AddNew methods. (Inherited from FChoice.Foundation.FCGeneric)
Public Property DataFields Collection of data fields that will be returned when Query is invoked. If no fields are selected all fields are returned. (Inherited from FChoice.Foundation.FCGeneric)
Public Property DataRestrictionsEnabled
Sets whether or not this FCGeneric will have the DataRestrictions feature enabled if available. (Inherited from FChoice.Foundation.FCGeneric)
Public Property DataSet  
Public Property DeleteRelationsToUnrelate (Inherited from FChoice.Foundation.FCGeneric)
Public Property Filter This is the root filter used to constrain rows returned during Query operations. Initially there are no filters present with filters being added using the AddFilter method. (Inherited from FChoice.Foundation.FCGeneric)
Public Property IncludeRelations Queries will retrieve all relation fields for the Generic (Inherited from FChoice.Foundation.FCGeneric)
Public Property IsDistinct Is this a Generic that should query for only discinct rows. (Inherited from FChoice.Foundation.FCGeneric)
Public Property IsSynchronized Gets a value indicating whether access to the FCGeneric is synchronized (thread-safe). (Inherited from FChoice.Foundation.FCGeneric)
Public Property Item Gets the ClarifyDataRow at the specified index in this ClarifyGeneric  
Public Property MaximumRows Controls the maximum number of rows to be returned by the Genric Query. (Inherited from FChoice.Foundation.FCGeneric)
Public Property ParentGeneric Gets a reference to the parent ClarifyGeneric if this generic is a child  
Public Property ParentRelation Gets a reference to the ISchemaRelation schema object which represents the relation used to traverse from the ParentGeneric  
Public Property QueryEmptyToNull Sets whether or not this FCGeneric will convert filters on empty strings into filters on Queries that check IS NULL or IS NOT NULL. (Inherited from FChoice.Foundation.FCGeneric)
Public Property RawFilter Sets an optional WHERE clause constraint. (WARNING: See remarks for potential security implications) (Inherited from FChoice.Foundation.FCGeneric)
Public Property RestrictionGroup Override the Session Data Restriction Group of this Generic. The ChangeRestrictionGroup method is available as a helper. (Inherited from FChoice.Foundation.FCGeneric)
Public Property Rows Gets a reference to the ClarifyRowCollection which contains all the rows queried for this generic  
Public Property SchemaTable  
Public Property SearchableFieldPrefix Overridden.   
Public Property Session Gets a reference to the parent ClarifySession of this generic.  
Public Property SetNullStringsToEmpty Sets whether or not this FCGeneric will convert a null reference (Nothing in Visual Basic) to empty strings. (Inherited from FChoice.Foundation.FCGeneric)
Public Property SyncRoot Gets an object that can be used to synchronize access to the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public Property TableName Returns the name of the database table this FCGeneric is based on. (Inherited from FChoice.Foundation.FCGeneric)

Public Methods

  Name Description
Public Method AddForUpdate
Creates a new row in the ClarifyGeneric with the specified objId which will be used to update an existing row in the database rather than inserting a new one.
Public Method AddNew Overloaded. Adds a new row and schedules it for creation in the database when Update is called  
Public Method AppendFilter Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a numeric DataField. (Inherited from FChoice.Foundation.FCGeneric)
Public Method AppendFilterBetween Overloaded. Adds a specialized filter to constrain the results of an FCGeneric Query to be between two Integer values. (Inherited from FChoice.Foundation.FCGeneric)
Public Method AppendFilterInList Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a list of possible Integer values**.** (Inherited from FChoice.Foundation.FCGeneric)
Public Method AppendFilterIsNull Adds a filter to constrain the results of an FCGeneric Query against NULL or NOT NULL fields. (Inherited from FChoice.Foundation.FCGeneric)
Public Method AppendSort Overloaded.  (Inherited from FChoice.Foundation.FCGeneric)
Public Method AssignAllObjIDs  
Public Method AssignObjID (Inherited from FChoice.Foundation.FCGeneric)
Public Method ChangeRestrictionGroup Change the Data Restriction Group of this generic instance overriding the Session default. This method is a helper for when you only know the name of the restriction group. (Inherited from FChoice.Foundation.FCGeneric)
Public Method ClearFilters Clears all filters that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric)
Public Method ClearSorts Clears all sort operations that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric)
Public Method CopyTo Copies all the rows of the current FCGeneric into to a one-dimensional Array. (Inherited from FChoice.Foundation.FCGeneric)
Public Method DeleteAll Delete all rows present in this FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public Method DeleteById Deletes the row in the table with the specified objid  
Public Method GetEnumerator Returns an IEnumerator for the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public Method Query Overloaded. Overridden. Causes the generic object to query the database table or view using the optionally specified data fields, filters, and sort orders  
Public Method Traverse Creates a child generic that is related to this generic through the specified relation  
Public Method TraverseFromParent Makes this generic a child that is related to the specified parent generic through the specified relation  
Public Method TraverseFromRoot  
Public Method Update Overloaded. Updates changes to a single GenericDataRow (Inherited from FChoice.Foundation.FCGeneric)
Public Method UpdateAll Overloaded. Updates all modified rows of the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)

Public Events

  Name Description
Public Event MaximumRowsExceeded This event is fired when the MaximumRows property is set and a Query operation has returned too many rows. (Inherited from FChoice.Foundation.FCGeneric)

Reference

ClarifyGeneric Class
FChoice.Foundation.Clarify Namespace

Back to top © 2022 Dovetail Software, Inc. - All rights reserved.
Clarify, Amdocs, and related products and names are copyright and trademark of Amdocs, Inc.
.NET, Visual Studio.NET, C#, Visual Basic and related products are trademark of Microsoft corporation.