Show / Hide Table of Contents

Class ClarifyApplication

Inheritance
System.Object
FCApplication
ClarifyApplication
Implements
IClarifyApplication
Inherited Members
FCApplication.SyncRoot
FCApplication.FCAppInitialize(CacheBase[], ISchemaCache)
FCApplication.RemoveSession(FCSession)
FCApplication.AddSessionData(FCSessionData)
FCApplication.SaveSessionData(FCSessionData)
FCApplication.GetSessionData(Guid)
FCApplication.FCAppParseConnectionString(String, String)
FCApplication.FCAppParseConnectionString(String, String, String, String, String)
FCApplication.SetInitializeComplete(Boolean)
FCApplication.CurrentSessions()
FCApplication.LogError(String, Object[])
FCApplication.LogError(Exception, String, Object[])
FCApplication.LogWarn(String, Object[])
FCApplication.LogWarn(Exception, String, Object[])
FCApplication.LogInfo(String, Object[])
FCApplication.LogInfo(Exception, String, Object[])
FCApplication.LogDebug(String, Object[])
FCApplication.LogDebug(Exception, String, Object[])
FCApplication.Log(LogLevel, String, Object[])
FCApplication.Log(LogLevel, Exception, String, Object[])
FCApplication.Deinitialize()
FCApplication.IsInitialized
FCApplication.Username
FCApplication.DatabaseVersion
FCApplication.FCAppInstance
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.Clarify
Assembly: fcSDK.dll
Syntax
public class ClarifyApplication : FCApplication, IClarifyApplication

Constructors

ClarifyApplication()

Declaration
protected ClarifyApplication()

Properties

ClarifyVersion

Declaration
public string ClarifyVersion { get; }
Property Value
Type Description
System.String

ConfigItemCache

Declaration
public ConfigItemCache ConfigItemCache { get; }
Property Value
Type Description
ConfigItemCache

ConfigItems

Declaration
public ClarifyConfigItemCollection ConfigItems { get; }
Property Value
Type Description
ClarifyConfigItemCollection

Configuration

Declaration
public NameValueCollection Configuration { get; }
Property Value
Type Description
System.Collections.Specialized.NameValueCollection

ConvertTimeZone

Declaration
public bool ConvertTimeZone { get; set; }
Property Value
Type Description
System.Boolean

DataRestrictionsEnabled

Declaration
public bool DataRestrictionsEnabled { get; }
Property Value
Type Description
System.Boolean

DBUserName

Declaration
public string DBUserName { get; }
Property Value
Type Description
System.String

FCAppDataRestrictionsEnabled

Declaration
protected override bool FCAppDataRestrictionsEnabled { get; }
Property Value
Type Description
System.Boolean
Overrides
FCApplication.FCAppDataRestrictionsEnabled

FCAppServerTimeZone

Declaration
protected override ITimeZone FCAppServerTimeZone { get; }
Property Value
Type Description
ITimeZone
Overrides
FCApplication.FCAppServerTimeZone

Instance

Declaration
public static ClarifyApplication Instance { get; }
Property Value
Type Description
ClarifyApplication

IsDbUnicode

Declaration
[Obsolete("Use the SchemaCache IsDatabaseUnicode property")]
public bool IsDbUnicode { get; }
Property Value
Type Description
System.Boolean

IsTravelerEnabled

Declaration
public bool IsTravelerEnabled { get; }
Property Value
Type Description
System.Boolean

ListCache

Declaration
public IListCache ListCache { get; }
Property Value
Type Description
IListCache

LocaleCache

Declaration
public ILocaleCache LocaleCache { get; }
Property Value
Type Description
ILocaleCache

SchemaCache

Declaration
public SchemaCache SchemaCache { get; }
Property Value
Type Description
SchemaCache

ServerTimeZone

Declaration
public ITimeZone ServerTimeZone { get; set; }
Property Value
Type Description
ITimeZone

StringCache

Declaration
public IStringCache StringCache { get; }
Property Value
Type Description
IStringCache

TimeZoneConversions

Declaration
public ExcludedColumns TimeZoneConversions { get; }
Property Value
Type Description
ExcludedColumns

TruncateStringFields

Declaration
public bool TruncateStringFields { get; set; }
Property Value
Type Description
System.Boolean

Methods

BeginInitialize(AsyncCallback, Object)

Declaration
public static IAsyncResult BeginInitialize(AsyncCallback callback, object state)
Parameters
Type Name Description
System.AsyncCallback callback
System.Object state
Returns
Type Description
System.IAsyncResult

CreateSession()

Declaration
public ClarifySession CreateSession()
Returns
Type Description
ClarifySession

CreateSession(String, ClarifyLoginType)

Declaration
public virtual ClarifySession CreateSession(string userName, ClarifyLoginType loginType)
Parameters
Type Name Description
System.String userName
ClarifyLoginType loginType
Returns
Type Description
ClarifySession

CreateSession(String, String, ClarifyLoginType)

Declaration
public virtual ClarifySession CreateSession(string userName, string password, ClarifyLoginType loginType)
Parameters
Type Name Description
System.String userName
System.String password
ClarifyLoginType loginType
Returns
Type Description
ClarifySession

CreateSessionData()

Declaration
protected virtual ClarifySessionData CreateSessionData()
Returns
Type Description
ClarifySessionData

EncryptClarifyPassword(String)

Declaration
public string EncryptClarifyPassword(string password)
Parameters
Type Name Description
System.String password
Returns
Type Description
System.String

EncryptDBPassword(String)

Declaration
public string EncryptDBPassword(string password)
Parameters
Type Name Description
System.String password
Returns
Type Description
System.String

EndInitialize(IAsyncResult)

Declaration
public static ClarifyApplication EndInitialize(IAsyncResult result)
Parameters
Type Name Description
System.IAsyncResult result
Returns
Type Description
ClarifyApplication

GetMtmTableName(SchemaRelation)

Declaration
public string GetMtmTableName(SchemaRelation relation)
Parameters
Type Name Description
SchemaRelation relation
Returns
Type Description
System.String

GetObjID(String)

Declaration
public int GetObjID(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
System.Int32

GetObjIdsFromFCStoredProcedure(Int32, Int32, Int32)

Declaration
public static int[] GetObjIdsFromFCStoredProcedure(int numberOfIdRequested, int clarifyBaseObjId, int objectTypeId)
Parameters
Type Name Description
System.Int32 numberOfIdRequested
System.Int32 clarifyBaseObjId
System.Int32 objectTypeId
Returns
Type Description
System.Int32[]

GetSession(Guid)

Declaration
public virtual ClarifySession GetSession(Guid sessionID)
Parameters
Type Name Description
System.Guid sessionID
Returns
Type Description
ClarifySession

Initialize()

Declaration
public static ClarifyApplication Initialize()
Returns
Type Description
ClarifyApplication

Initialize(NameValueCollection)

Declaration
public static ClarifyApplication Initialize(NameValueCollection configValues)
Parameters
Type Name Description
System.Collections.Specialized.NameValueCollection configValues
Returns
Type Description
ClarifyApplication

InitializeInternal(NameValueCollection, CacheBase[], ISchemaCache)

Declaration
protected void InitializeInternal(NameValueCollection configValues, CacheBase[] caches, ISchemaCache schemaMaster)
Parameters
Type Name Description
System.Collections.Specialized.NameValueCollection configValues
CacheBase[] caches
ISchemaCache schemaMaster

IsSessionValid(Guid)

Declaration
public bool IsSessionValid(Guid sessionID)
Parameters
Type Name Description
System.Guid sessionID
Returns
Type Description
System.Boolean

ParseConnectionString(out String, out String)

Declaration
protected NameValueCollection ParseConnectionString(out string username, out string password)
Parameters
Type Name Description
System.String username
System.String password
Returns
Type Description
System.Collections.Specialized.NameValueCollection

ParseConnectionString(out String, out String, out String, out String, out String)

Declaration
protected NameValueCollection ParseConnectionString(out string username, out string password, out string usernameKey, out string passwordKey, out string integratedSecurityKey)
Parameters
Type Name Description
System.String username
System.String password
System.String usernameKey
System.String passwordKey
System.String integratedSecurityKey
Returns
Type Description
System.Collections.Specialized.NameValueCollection

ValidateEncryptedPassword(String, String, Boolean)

Declaration
public static bool ValidateEncryptedPassword(string password, string passHash, bool pre9)
Parameters
Type Name Description
System.String password
System.String passHash
System.Boolean pre9
Returns
Type Description
System.Boolean

Events

InitializeStatusChange

Declaration
public static event InitializeStatusChangeEventHandler InitializeStatusChange
Event Type
Type Description
InitializeStatusChangeEventHandler

Implements

IClarifyApplication
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.