fcSDK Documentation
ClarifyGeneric Class Members
Fields  Properties  Methods  Events

The following tables list the members exposed by ClarifyGeneric.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)GuidColumnName  
Top
Public Properties
 NameDescription
Public PropertyChildGenericsGets an IDictionary of associated child generics keyed by their relation from the parent (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyCountReturns the number of rows currently populated by the Query or AddNew methods. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyDataFieldsCollection 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 PropertyDataRestrictionsEnabled

Sets whether or not this FCGeneric will have the DataRestrictions feature enabled if available.

(Inherited from FChoice.Foundation.FCGeneric)
Public PropertyDataSet  
Public PropertyDeleteRelationsToUnrelate (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyFilterThis 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 PropertyIncludeRelationsQueries will retrieve all relation fields for the Generic (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyIsDistinctIs this a Generic that should query for only discinct rows. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyIsSynchronizedGets a value indicating whether access to the FCGeneric is synchronized (thread-safe). (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyItemGets the ClarifyDataRow at the specified index in this ClarifyGeneric  
Public PropertyMaximumRowsControls the maximum number of rows to be returned by the Genric Query. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyParentGenericGets a reference to the parent ClarifyGeneric if this generic is a child  
Public PropertyParentRelationGets a reference to the ISchemaRelation schema object which represents the relation used to traverse from the ParentGeneric  
Public PropertyQueryEmptyToNull

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 PropertyRawFilter

Sets an optional WHERE clause constraint. (WARNING: See remarks for potential security implications)

(Inherited from FChoice.Foundation.FCGeneric)
Public PropertyRestrictionGroupOverride the Session Data Restriction Group of this Generic. The ChangeRestrictionGroup method is available as a helper. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyRowsGets a reference to the ClarifyRowCollection which contains all the rows queried for this generic  
Public PropertySchemaTable  
Public PropertySearchableFieldPrefixOverridden.   
Public PropertySessionGets a reference to the parent ClarifySession of this generic.  
Public PropertySetNullStringsToEmptySets whether or not this FCGeneric will convert a null reference (Nothing in Visual Basic) to empty strings. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertySyncRootGets an object that can be used to synchronize access to the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public PropertyTableNameReturns the name of the database table this FCGeneric is based on. (Inherited from FChoice.Foundation.FCGeneric)
Top
Public Methods
 NameDescription
Public MethodAddForUpdate

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 MethodAddNewOverloaded. Adds a new row and schedules it for creation in the database when Update is called  
Public MethodAppendFilterOverloaded. Adds a filter to constrain the results of an FCGeneric Query against a numeric DataField. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodAppendFilterBetweenOverloaded. Adds a specialized filter to constrain the results of an FCGeneric Query to be between two Integer values. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodAppendFilterInListOverloaded. Adds a filter to constrain the results of an FCGeneric Query against a list of possible Integer values. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodAppendFilterIsNullAdds a filter to constrain the results of an FCGeneric Query against NULL or NOT NULL fields. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodAppendSortOverloaded.  (Inherited from FChoice.Foundation.FCGeneric)
Public MethodAssignAllObjIDs  
Public MethodAssignObjID (Inherited from FChoice.Foundation.FCGeneric)
Public MethodChangeRestrictionGroupChange 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 MethodClearFiltersClears all filters that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodClearSortsClears all sort operations that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodCopyToCopies all the rows of the current FCGeneric into to a one-dimensional Array. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodDeleteAllDelete all rows present in this FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodDeleteByIdDeletes the row in the table with the specified objid  
Public MethodGetEnumeratorReturns an IEnumerator for the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Public MethodQueryOverloaded. Overridden. Causes the generic object to query the database table or view using the optionally specified data fields, filters, and sort orders  
Public MethodTraverseCreates a child generic that is related to this generic through the specified relation  
Public MethodTraverseFromParentMakes this generic a child that is related to the specified parent generic through the specified relation  
Public MethodTraverseFromRoot  
Public MethodUpdateOverloaded. Updates changes to a single GenericDataRow (Inherited from FChoice.Foundation.FCGeneric)
Public MethodUpdateAllOverloaded. Updates all modified rows of the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric)
Top
Public Events
 NameDescription
Public EventMaximumRowsExceededThis event is fired when the MaximumRows property is set and a Query operation has returned too many rows. (Inherited from FChoice.Foundation.FCGeneric)
Top
See Also

Reference

ClarifyGeneric Class
FChoice.Foundation.Clarify Namespace

 

 


© 2010 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.

Send comments on this topic.