ClarifyApplication Class Members

The following tables list the members exposed by ClarifyApplication.

Public Properties

  Name Description
Public Property ClarifyVersion Gets a string which describes the version of Clarify that ClarifyApplication is currently running against.  
Public Property ConfigItemCache Gets a reference to the ConfigItemCache for accessing Clarify config items.  
Public Property ConfigItems Returns a dictionary that contains Clarify config item key/value pairs  
Public Property Configuration Collection of application parameters being used by the application object.  
Public Property ConvertTimeZone Gets or sets whether or not to perform time zone conversions when operating with date/time values  
Public Property DatabaseVersion (Inherited from FChoice.Foundation.FCApplication)
Public Property DataRestrictionsEnabled Gets whether or not First Choice Data Restriction technology is enabled for this Clarify database.  
Public Property DBUserName Name of the database user the application object is using to connect to the database.  
Public Propertystatic (Shared in Visual Basic) Instance Returns the singleton instance of ClarifyApplication if initialized.  
Public Property IsDbUnicode Gets whether or not any columns in the Clarify database are flagged as supporting Unicode characters.  
Public Property IsTravelerEnabled Gets whether or not the Clarify Traveler product is installed and enabled for this database.  
Public Property ListCache Gets a reference to the ListCache which provides access to Clarify user defined and global lists  
Public Property LocaleCache Gets a reference to the LocaleCache which provides access to city/state/country/time zone information.  
Public Property SchemaCache Gets a reference to the SchemaCache which provides access to the Clarify ADP schema information  
Public Property ServerTimeZone Timezone being used by the application.  
Public Property StringCache Gets a reference to the StringCache which provides access to the Clarify string DB table and First Choice FCStrings  
Public Property TruncateStringFields Gets or sets whether or not to truncate string values if they are too large for the field or throw an error  

Public Methods

  Name Description
Public Methodstatic (Shared in Visual Basic) BeginInitialize Begins an asynchronous ClarifyApplication initialization.  
Public Method CreateSession Overloaded. Creates a new ClarifySession and logs in using the username and password for the application.  
Public Method CurrentSessions Provides a view into the FCApplication's currently running sessions. (Inherited from FChoice.Foundation.FCApplication)
Public Method EncryptClarifyPassword Generates a string using the same obfuscation algorithm that is compatible with the Clarify Thin Client.  
Public Method EncryptDBPassword Obfuscates a database password using the Clarify DB password obfuscation algorithm.  
Public Methodstatic (Shared in Visual Basic) EndInitialize Ends an asynchronous ClarifyApplication initialization.  
Public Method GetMtmTableName Returns the name of the physical MTM table for a given MTM relationship using the Clarify MTM naming conventions  
Public Method GetObjID Gets the next objid for the given table  
Public Methodstatic (Shared in Visual Basic) GetObjIdsFromFCStoredProcedure  
Public Method GetSession Retrieves an ClarifySession previously created by CreateSession.  
Public Methodstatic (Shared in Visual Basic) Initialize Overloaded. Initializes ClarifyApplication using the application configuration.  
Public Method IsSessionValid  
Public Methodstatic (Shared in Visual Basic) ValidateEncryptedPassword  

Public Events

  Name Description
Public Event InitializeStatusChange Event fired during Initialization, relaying information about the current status of the initialization process.  

Reference

ClarifyApplication Class
FChoice.Foundation.Clarify Namespace