Class FCSession

Inheritance

System.Object

FCSession

ClarifySession

Implements

System.IDisposable

Inherited Members

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

Assembly: fcSDK.dll

Syntax

public abstract class FCSession : IDisposable

Constructors

FCSession()

Declaration

protected FCSession()

FCSession(FCSessionData)

Declaration

protected FCSession(FCSessionData data)

Parameters

Type	Name	Description
FCSessionData	data

FCSession(FCSessionData, String, Int32)

Declaration

protected FCSession(FCSessionData data, string userName, int loginType)

Parameters

Type	Name	Description
FCSessionData	data
System.String	userName
System.Int32	loginType

FCSession(FCSessionData, String, String, Int32)

Declaration

protected FCSession(FCSessionData data, string userName, string password, int loginType)

Parameters

Type	Name	Description
FCSessionData	data
System.String	userName
System.String	password
System.Int32	loginType

Properties

ConfigItems

Declaration

public ConfigItemCollection ConfigItems { get; }

Property Value

Type	Description
ConfigItemCollection

ConvertTimeZone

Declaration

public bool ConvertTimeZone { get; set; }

Property Value

Type	Description
System.Boolean

CreationTime

Declaration

public DateTime CreationTime { get; }

Property Value

Type	Description
System.DateTime

CurrentCulture

Declaration

public CultureInfo CurrentCulture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo

DataRestrictionsEnabled

Declaration

public bool DataRestrictionsEnabled { get; set; }

Property Value

Type	Description
System.Boolean

DefaultCulture

Declaration

public CultureInfo DefaultCulture { get; }

Property Value

Type	Description
System.Globalization.CultureInfo

DefaultDistinctGenerics

Declaration

public bool DefaultDistinctGenerics { get; set; }

Property Value

Type	Description
System.Boolean

DisableDataConversions

Declaration

public bool DisableDataConversions { get; set; }

Property Value

Type	Description
System.Boolean

IncludeRelations

Declaration

public bool IncludeRelations { get; set; }

Property Value

Type	Description
System.Boolean

Item[String]

Declaration

public object this[string key] { get; set; }

Parameters

Type	Name	Description
System.String	key

Property Value

Type	Description
System.Object

Items

Declaration

public IDictionary Items { get; }

Property Value

Type	Description
System.Collections.IDictionary

LastLoadTime

Declaration

public DateTime LastLoadTime { get; }

Property Value

Type	Description
System.DateTime

LocalTimeZone

Declaration

public ITimeZone LocalTimeZone { get; set; }

Property Value

Type	Description
ITimeZone

Log

Declaration

public Logger Log { get; }

Property Value

Type	Description
Logger

LoginType

Declaration

public int LoginType { get; }

Property Value

Type	Description
System.Int32

MaximumRows

Declaration

public int MaximumRows { get; set; }

Property Value

Type	Description
System.Int32

PasswordRequired

Declaration

public bool PasswordRequired { get; }

Property Value

Type	Description
System.Boolean

QueryEmptyToNull

Declaration

public bool QueryEmptyToNull { get; set; }

Property Value

Type	Description
System.Boolean

RestrictionGroup

Declaration

public RestrictionGroup RestrictionGroup { get; }

Property Value

Type	Description
RestrictionGroup

SessionData

Declaration

public FCSessionData SessionData { get; }

Property Value

Type	Description
FCSessionData

SessionID

Declaration

public Guid SessionID { get; }

Property Value

Type	Description
System.Guid

SetNullStringsToEmpty

Declaration

public bool SetNullStringsToEmpty { get; set; }

Property Value

Type	Description
System.Boolean

TimeZoneConversions

Declaration

public ExcludedColumns TimeZoneConversions { get; set; }

Property Value

Type	Description
ExcludedColumns

TruncateStringFields

Declaration

public bool TruncateStringFields { get; set; }

Property Value

Type	Description
System.Boolean

UserID

Declaration

public object UserID { get; }

Property Value

Type	Description
System.Object

UserName

Declaration

public string UserName { get; }

Property Value

Type	Description
System.String

Methods

_GetNextDataTableId()

Declaration

protected string _GetNextDataTableId()

Returns

Type	Description
System.String

ChangePassword(String)

Declaration

public void ChangePassword(string newPassword)

Parameters

Type	Name	Description
System.String	newPassword

ChangeRestrictionGroup(String, Boolean)

Declaration

public virtual void ChangeRestrictionGroup(string newGroupName, bool saveChange)

Parameters

Type	Name	Description
System.String	newGroupName
System.Boolean	saveChange

CloseSession()

Declaration

public void CloseSession()

CloseSession(Boolean)

Declaration

protected void CloseSession(bool nullDataReference)

Parameters

Type	Name	Description
System.Boolean	nullDataReference

ConvertDate(DateTime, ITimeZone, ITimeZone)

Declaration

public virtual DateTime ConvertDate(DateTime date, ITimeZone fromTZ, ITimeZone toTZ)

Parameters

Type	Name	Description
System.DateTime	date
ITimeZone	fromTZ
ITimeZone	toTZ

Returns

Type	Description
System.DateTime

ConvertDate(DateTime, String, String)

Declaration

public virtual DateTime ConvertDate(DateTime date, string fromTZName, string toTZName)

Parameters

Type	Name	Description
System.DateTime	date
System.String	fromTZName
System.String	toTZName

Returns

Type	Description
System.DateTime

ConvertFromLocalToServerDate(DateTime)

Declaration

public virtual DateTime ConvertFromLocalToServerDate(DateTime date)

Parameters

Type	Name	Description
System.DateTime	date

Returns

Type	Description
System.DateTime

ConvertFromServerToLocalDate(DateTime)

Declaration

public virtual DateTime ConvertFromServerToLocalDate(DateTime date)

Parameters

Type	Name	Description
System.DateTime	date

Returns

Type	Description
System.DateTime

Dispose()

Declaration

public virtual void Dispose()

FormatElapsedTime(Double)

Declaration

public virtual string FormatElapsedTime(double elapsedTime)

Parameters

Type	Name	Description
System.Double	elapsedTime

Returns

Type	Description
System.String

FormatElapsedTime(Int32)

Declaration

public virtual string FormatElapsedTime(int elapsedTime)

Parameters

Type	Name	Description
System.Int32	elapsedTime

Returns

Type	Description
System.String

FormatElapsedTime(TimeSpan)

Declaration

public virtual string FormatElapsedTime(TimeSpan ts)

Parameters

Type	Name	Description
System.TimeSpan	ts

Returns

Type	Description
System.String

GetAssignedPermissions()

Declaration

public virtual string[] GetAssignedPermissions()

Returns

Type	Description
System.String[]

GetCurrentDate()

Declaration

public virtual DateTime GetCurrentDate()

Returns

Type	Description
System.DateTime

GetCurrentServerDate()

Declaration

public virtual DateTime GetCurrentServerDate()

Returns

Type	Description
System.DateTime

GetRestrictionGroupForUser(Object)

Declaration

protected abstract RestrictionGroup GetRestrictionGroupForUser(object UserID)

Parameters

Type	Name	Description
System.Object	UserID

Returns

Type	Description
RestrictionGroup

HasPermission(String)

Declaration

public virtual bool HasPermission(string permission)

Parameters

Type	Name	Description
System.String	permission

Returns

Type	Description
System.Boolean

InitializeSession(FCSessionData)

Declaration

protected virtual void InitializeSession(FCSessionData data)

Parameters

Type	Name	Description
FCSessionData	data

LoadSessionDataFromApplicationCache(Guid)

Declaration

protected static FCSessionData LoadSessionDataFromApplicationCache(Guid sessionId)

Parameters

Type	Name	Description
System.Guid	sessionId

Returns

Type	Description
FCSessionData

LoginFromApp()

Declaration

protected void LoginFromApp()

LoginInternal(String, String, Int32, Boolean, Boolean, Boolean)

Declaration

protected void LoginInternal(string inUsername, string password, int inLoginType, bool isLoginTypeSpecified, bool passwordRequired, bool cleanupOnError)

Parameters

Type	Name	Description
System.String	inUsername
System.String	password
System.Int32	inLoginType
System.Boolean	isLoginTypeSpecified
System.Boolean	passwordRequired
System.Boolean	cleanupOnError

PerformChangePassword(String, String, Int32)

Declaration

protected abstract void PerformChangePassword(string username, string newPassword, int LoginType)

Parameters

Type	Name	Description
System.String	username
System.String	newPassword
System.Int32	LoginType

PerformChangeResGroup(String, Boolean)

Declaration

protected abstract RestrictionGroup PerformChangeResGroup(string newGroup, bool saveToDb)

Parameters

Type	Name	Description
System.String	newGroup
System.Boolean	saveToDb

Returns

Type	Description
RestrictionGroup

PerformConvertDate(DateTime, ITimeZone, ITimeZone)

Declaration

protected abstract DateTime PerformConvertDate(DateTime date, ITimeZone fromTZ, ITimeZone toTZ)

Parameters

Type	Name	Description
System.DateTime	date
ITimeZone	fromTZ
ITimeZone	toTZ

Returns

Type	Description
System.DateTime

PerformConvertDate(DateTime, String, String)

Declaration

protected abstract DateTime PerformConvertDate(DateTime date, string fromTZName, string toTZName)

Parameters

Type	Name	Description
System.DateTime	date
System.String	fromTZName
System.String	toTZName

Returns

Type	Description
System.DateTime

PerformLogin(String, Int32)

Declaration

protected abstract object PerformLogin(string inUsername, int inLoginType)

Parameters

Type	Name	Description
System.String	inUsername
System.Int32	inLoginType

Returns

Type	Description
System.Object

PerformLogin(String, String)

Declaration

protected abstract object PerformLogin(string inUsername, string password)

Parameters

Type	Name	Description
System.String	inUsername
System.String	password

Returns

Type	Description
System.Object

PerformLogin(String, String, Int32)

Declaration

protected abstract object PerformLogin(string inUsername, string password, int inLoginType)

Parameters

Type	Name	Description
System.String	inUsername
System.String	password
System.Int32	inLoginType

Returns

Type	Description
System.Object

PerformRefreshContext()

Declaration

protected abstract void PerformRefreshContext()

PerformSetPassword(String, String, Int32)

Declaration

protected abstract void PerformSetPassword(string username, string newPassword, int LoginType)

Parameters

Type	Name	Description
System.String	username
System.String	newPassword
System.Int32	LoginType

RefreshContext()

Declaration

public virtual void RefreshContext()

RegisterLicenseRequirements(Int32)

Declaration

public void RegisterLicenseRequirements(int productId)

Parameters

Type	Name	Description
System.Int32	productId

ResetSessionLoginStatus()

Declaration

protected virtual void ResetSessionLoginStatus()

SaveSession()

Declaration

public void SaveSession()

SetPassword(String, String, Int32)

Declaration

public void SetPassword(string inUsername, string newPass, int LoginType)

Parameters

Type	Name	Description
System.String	inUsername
System.String	newPass
System.Int32	LoginType

SetupSessionData(FCSessionData)

Declaration

protected abstract void SetupSessionData(FCSessionData data)

Parameters

Type	Name	Description
FCSessionData	data

ShouldConvertToLocalDate(DateTime, DataColumn)

Declaration

public bool ShouldConvertToLocalDate(DateTime dateTimeValue, DataColumn column)

Parameters

Type	Name	Description
System.DateTime	dateTimeValue
System.Data.DataColumn	column

Returns

Type	Description
System.Boolean

UpdateLastLogin(String)

Declaration

protected abstract void UpdateLastLogin(string inUsername)

Parameters

Type	Name	Description
System.String	inUsername

Implements

System.IDisposable