fcSDK Documentation
FCGeneric Class Members
Fields  Properties  Methods  Events

The following tables list the members exposed by FCGeneric.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)MAX_DATEMaximum possible date that is allowed to be entered for a date field.  
Public Fieldstatic (Shared in Visual Basic)MIN_DATEMinimum possible date that is allowed to be entered for a date field.  
Public Fieldstatic (Shared in Visual Basic)NOW_DATEWhen date fields are set to this value the current server datetime will be entered instead.  
Top
Public Properties
 NameDescription
Public PropertyChildGenericsReturns a dictionary (keyed by parent to child relation name) of child generics belonging to this FCGeneric.  
Public PropertyCountReturns the number of rows currently populated by the Query or AddNew methods.  
Public PropertyDataFieldsCollection of data fields that will be returned when Query is invoked. If no fields are selected all fields are returned.  
Public PropertyDataRestrictionsEnabled

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

 
Public PropertyDeleteRelationsToUnrelate  
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.  
Public PropertyIncludeRelationsQueries will retrieve all relation fields for the Generic  
Public PropertyIsDistinctIs this a Generic that should query for only discinct rows.  
Public PropertyIsSynchronizedGets a value indicating whether access to the FCGeneric is synchronized (thread-safe).  
Public PropertyMaximumRowsControls the maximum number of rows to be returned by the Genric Query.  
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.

 
Public PropertyRawFilter

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

 
Public PropertyRestrictionGroupOverride the Session Data Restriction Group of this Generic. The ChangeRestrictionGroup method is available as a helper.  
Public PropertySearchableFieldPrefix  
Public PropertySetNullStringsToEmptySets whether or not this FCGeneric will convert a null reference (Nothing in Visual Basic) to empty strings.  
Public PropertySyncRootGets an object that can be used to synchronize access to the FCGeneric.  
Public PropertyTableNameReturns the name of the database table this FCGeneric is based on.  
Top
Public Methods
 NameDescription
Public MethodAppendFilterOverloaded. Adds a filter to constrain the results of an FCGeneric Query against a numeric DataField.  
Public MethodAppendFilterBetweenOverloaded. Adds a specialized filter to constrain the results of an FCGeneric Query to be between two Integer values.  
Public MethodAppendFilterInListOverloaded. Adds a filter to constrain the results of an FCGeneric Query against a list of possible Integer values.  
Public MethodAppendFilterIsNullAdds a filter to constrain the results of an FCGeneric Query against NULL or NOT NULL fields.  
Public MethodAppendSortOverloaded. Adds a field by which the results of an FCGeneric Query will be sorted.  
Public MethodAssignObjID  
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.  
Public MethodClearFiltersClears all filters that have been appended to this generic.  
Public MethodClearSortsClears all sort operations that have been appended to this generic.  
Public MethodCopyToCopies all the rows of the current FCGeneric into to a one-dimensional Array.  
Public MethodDeleteAllDelete all rows present in this FCGeneric.  
Public MethodGetEnumeratorReturns an IEnumerator for the FCGeneric.  
Public MethodQueryOverloaded. Causes the generic object to query the database table or view using the optionally specified data fields, filters, and sort orders  
Public MethodUpdateOverloaded. Updates changes to a single GenericDataRow  
Public MethodUpdateAllOverloaded. Updates all modified rows of the 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.  
Top
See Also

Reference

FCGeneric Class
FChoice.Foundation 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.