Class FCSession

Inheritance
System.Object
FCSession
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.Clarify.Compatibility
Assembly: FChoice.Foundation.Clarify.Compatibility.dll
Syntax
[ComVisible(true)]
[Guid("906C1CC2-5CE2-456b-BF53-129336DAA394")]
[ClassInterface(ClassInterfaceType.None)]
public sealed class FCSession : IFCSession, IDisposable

Properties

ad_auto

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

ad_list

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

BulkCollection

Declaration
public IMockCollection BulkCollection { get; }
Property Value
Type Description
IMockCollection

ConvertTimeZone

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

cur_res

Declaration
public IMockCollection cur_res { get; set; }
Property Value
Type Description
IMockCollection

CurrentCulture

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

CurrentNetTransaction

Declaration
[ComVisible(false)]
public IDbTransaction CurrentNetTransaction { get; set; }
Property Value
Type Description
System.Data.IDbTransaction

DbHelper

Declaration
[ComVisible(false)]
public SqlHelper DbHelper { get; }
Property Value
Type Description
SqlHelper

Distinct

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

ErrorMessage

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

ErrorNumber

Declaration
public short ErrorNumber { get; set; }
Property Value
Type Description
System.Int16

ErrorSource

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

hist_change

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

IncludeRelations

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

IsInTransaction

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

IsLoggedIn

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

Item[String]

Declaration
[ComVisible(false)]
public object this[string key] { get; set; }
Parameters
Type Name Description
System.String key
Property Value
Type Description
System.Object

LocalTimeZone

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

LocalTimeZoneOffset

Declaration
public int LocalTimeZoneOffset { get; }
Property Value
Type Description
System.Int32

LoginTime

Declaration
public DateTime LoginTime { get; }
Property Value
Type Description
System.DateTime

NoRes

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

num_ad

Declaration
public short num_ad { get; set; }
Property Value
Type Description
System.Int16

PasswordRequired

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

QueryEmptyToNull

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

RESEnabled

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

rowLimit

Declaration
public int rowLimit { get; set; }
Property Value
Type Description
System.Int32

SessionID

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

SetNullStringsToEmpty

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

ThrowErrors

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

TruncateStringFields

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

UpdateTime

Declaration
public DateTime UpdateTime { get; }
Property Value
Type Description
System.DateTime

Methods

accept_object(String, ref String, ref String, ref String, Boolean, String)

Declaration
public short accept_object(string objId, ref string acceptDate, ref string wipBin, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String acceptDate
System.String wipBin
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

active_connection()

Declaration
public Connection active_connection()
Returns
Type Description
ADODB.Connection

AddAttachment(String, String, String, String, Object, Object)

Declaration
public short AddAttachment(string attachmentName, string filePath, string objectType, string idNumber, object objectObjId, object attachmentType)
Parameters
Type Name Description
System.String attachmentName
System.String filePath
System.String objectType
System.String idNumber
System.Object objectObjId
System.Object attachmentType
Returns
Type Description
System.Int16

AppendFilter(Object, String, String, Object, Object)

Declaration
public void AppendFilter(object fcGeneric, string fieldName, string filterOperator, object filterValue, object isAndOr)
Parameters
Type Name Description
System.Object fcGeneric
System.String fieldName
System.String filterOperator
System.Object filterValue
System.Object isAndOr

assign_object(String, ref String, String, ref String, ref String, Boolean, String)

Declaration
public short assign_object(string objId, ref string newUser, string wipBin, ref string assignDate, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String newUser
System.String wipBin
System.String assignDate
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

auto_dest(String, String, String)

Declaration
public short auto_dest(string objId, string operation, string idNumber)
Parameters
Type Name Description
System.String objId
System.String operation
System.String idNumber
Returns
Type Description
System.Int16

AutoDest(String, String, String)

Declaration
public short AutoDest(string the_object, string operation, string idNumber)
Parameters
Type Name Description
System.String the_object
System.String operation
System.String idNumber
Returns
Type Description
System.Int16

build_hist(String, String)

Declaration
public string build_hist(string currentHistory, string appendHistory)
Parameters
Type Name Description
System.String currentHistory
System.String appendHistory
Returns
Type Description
System.String

build_lists(String, Int32, String, Int32, String, String, String, String, String, String, ref IFCList, ref IFCList, ref IFCList, ref Int16)

Declaration
public void build_lists(string int_fld1, int int_val1, string int_fld2, int int_val2, string str_fld1, string str_val1, string str_fld2, string str_val2, string date_fld1, string date_val1, ref IFCList fld_list, ref IFCList type_list, ref IFCList val_list, ref short list_used)
Parameters
Type Name Description
System.String int_fld1
System.Int32 int_val1
System.String int_fld2
System.Int32 int_val2
System.String str_fld1
System.String str_val1
System.String str_fld2
System.String str_val2
System.String date_fld1
System.String date_val1
IFCList fld_list
IFCList type_list
IFCList val_list
System.Int16 list_used

BuildUserVersionProc()

Declaration
public string BuildUserVersionProc()
Returns
Type Description
System.String

change_obj_status(String, ref String, ref String, String, ref String, Boolean, String)

Declaration
public short change_obj_status(string objId, ref string newStatus, ref string changeDate, string notes, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String newStatus
System.String changeDate
System.String notes
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

ChangePassword(String)

Declaration
public void ChangePassword(string password)
Parameters
Type Name Description
System.String password

ChangeResGroup(String, Object)

Declaration
public void ChangeResGroup(string newGroup, object saveToDB)
Parameters
Type Name Description
System.String newGroup
System.Object saveToDB

check_cl_trans(String, String, String, String)

Declaration
public short check_cl_trans(string oldCondition, string newCondition, string reqType, string userName)
Parameters
Type Name Description
System.String oldCondition
System.String newCondition
System.String reqType
System.String userName
Returns
Type Description
System.Int16

CloseAllGenerics()

Declaration
public void CloseAllGenerics()

CloseGenerics(Int16, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Declaration
public void CloseGenerics(short NumGenerics, object Generic1, object Generic2, object Generic3, object Generic4, object Generic5, object Generic6, object Generic7, object Generic8, object Generic9, object Generic10)
Parameters
Type Name Description
System.Int16 NumGenerics
System.Object Generic1
System.Object Generic2
System.Object Generic3
System.Object Generic4
System.Object Generic5
System.Object Generic6
System.Object Generic7
System.Object Generic8
System.Object Generic9
System.Object Generic10

CloseSession()

Declaration
public void CloseSession()

CommitTransaction()

Declaration
public void CommitTransaction()

ConvertDate(DateTime, String, String)

Declaration
public DateTime ConvertDate(DateTime convertDate, string fromTimeZone, string toTimeZone)
Parameters
Type Name Description
System.DateTime convertDate
System.String fromTimeZone
System.String toTimeZone
Returns
Type Description
System.DateTime

ConvertFromLocalToServerTZ(DateTime)

Declaration
public DateTime ConvertFromLocalToServerTZ(DateTime convertDate)
Parameters
Type Name Description
System.DateTime convertDate
Returns
Type Description
System.DateTime

ConvertFromServerToLocalTZ(DateTime)

Declaration
public DateTime ConvertFromServerToLocalTZ(DateTime convertDate)
Parameters
Type Name Description
System.DateTime convertDate
Returns
Type Description
System.DateTime

create_act_entry(IFCGeneric, String, Int32, Int32, String, IFCGeneric, String, String, Object)

Declaration
public void create_act_entry(IFCGeneric mainRecord, string actName, int userId, int actCode, string currentDateTime, IFCGeneric activityRecord, string additionalInfo, string objectType, object optLinkRecord)
Parameters
Type Name Description
IFCGeneric mainRecord
System.String actName
System.Int32 userId
System.Int32 actCode
System.String currentDateTime
IFCGeneric activityRecord
System.String additionalInfo
System.String objectType
System.Object optLinkRecord

create_act_entry(IFCGeneric, String, Int32, Int32, String, IFCGeneric, String, String, String, Object)

Declaration
public void create_act_entry(IFCGeneric mainRecord, string actName, int userId, int actCode, string currentDateTime, IFCGeneric activityRecord, string additionalInfo, string objectType, string impersonatorUserName, object optLinkRecord)
Parameters
Type Name Description
IFCGeneric mainRecord
System.String actName
System.Int32 userId
System.Int32 actCode
System.String currentDateTime
IFCGeneric activityRecord
System.String additionalInfo
System.String objectType
System.String impersonatorUserName
System.Object optLinkRecord

create_time_bomb(ref IFCGeneric, IFCGeneric, String, IFCGeneric, String, Int32, String, String, Object)

Declaration
public void create_time_bomb(ref IFCGeneric timeBombRecord, IFCGeneric mainRecord, string t_save, IFCGeneric activityRecord, string the_type, int emp_rec, string t_date, string focus_obj, object new_generic)
Parameters
Type Name Description
IFCGeneric timeBombRecord
IFCGeneric mainRecord
System.String t_save
IFCGeneric activityRecord
System.String the_type
System.Int32 emp_rec
System.String t_date
System.String focus_obj
System.Object new_generic

create_time_bomb(ref IFCGeneric, IFCGeneric, String, IFCGeneric, String, Int32, String, String, String, Object)

Declaration
public void create_time_bomb(ref IFCGeneric timeBombRecord, IFCGeneric mainRecord, string t_save, IFCGeneric activityRecord, string the_type, int emp_rec, string t_date, string focus_obj, string escalate_time, object new_generic)
Parameters
Type Name Description
IFCGeneric timeBombRecord
IFCGeneric mainRecord
System.String t_save
IFCGeneric activityRecord
System.String the_type
System.Int32 emp_rec
System.String t_date
System.String focus_obj
System.String escalate_time
System.Object new_generic

create_time_bomb(Int32, ref IFCGeneric, IFCGeneric, String, IFCGeneric, Int32, String, String, Object)

Declaration
[ComVisible(false)]
public void create_time_bomb(int timeBombFlag, ref IFCGeneric timeBombRecord, IFCGeneric mainRecord, string t_save, IFCGeneric activityRecord, int emp_rec, string t_date, string focus_obj, object new_generic)
Parameters
Type Name Description
System.Int32 timeBombFlag
IFCGeneric timeBombRecord
IFCGeneric mainRecord
System.String t_save
IFCGeneric activityRecord
System.Int32 emp_rec
System.String t_date
System.String focus_obj
System.Object new_generic

create_time_bomb(Int32, ref IFCGeneric, IFCGeneric, String, IFCGeneric, Int32, String, String, String, Object)

Declaration
[ComVisible(false)]
public void create_time_bomb(int timeBombFlag, ref IFCGeneric timeBombRecord, IFCGeneric mainRecord, string t_save, IFCGeneric activityRecord, int emp_rec, string t_date, string focus_obj, string escalate_time, object new_generic)
Parameters
Type Name Description
System.Int32 timeBombFlag
IFCGeneric timeBombRecord
IFCGeneric mainRecord
System.String t_save
IFCGeneric activityRecord
System.Int32 emp_rec
System.String t_date
System.String focus_obj
System.String escalate_time
System.Object new_generic

createBulk(String)

Declaration
public IFCBulk createBulk(string bulkName)
Parameters
Type Name Description
System.String bulkName
Returns
Type Description
IFCBulk

CreateGeneric(Object)

Declaration
public IFCGeneric CreateGeneric(object dbObjectName)
Parameters
Type Name Description
System.Object dbObjectName
Returns
Type Description
IFCGeneric

CreateSqlExec()

Declaration
public IFCSqlExec CreateSqlExec()
Returns
Type Description
IFCSqlExec

dispatch_object(String, String, ref String, ref String, Boolean, String)

Declaration
public short dispatch_object(string objId, string queueName, ref string dispatchDate, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String queueName
System.String dispatchDate
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

Dispose()

Declaration
public void Dispose()

error_handler(Int16, String, String, FCExceptionBase)

Declaration
[ComVisible(false)]
public short error_handler(short errorNum, string objId, string source, FCExceptionBase exception)
Parameters
Type Name Description
System.Int16 errorNum
System.String objId
System.String source
FCExceptionBase exception
Returns
Type Description
System.Int16

error_handler(Int16, String, String, String)

Declaration
public short error_handler(short error_num, string objId, string source, string message)
Parameters
Type Name Description
System.Int16 error_num
System.String objId
System.String source
System.String message
Returns
Type Description
System.Int16

error_handler(Int32, String, String, String, Exception)

Declaration
[ComVisible(false)]
public short error_handler(int error_num, string objId, string source, string message, Exception ex)
Parameters
Type Name Description
System.Int32 error_num
System.String objId
System.String source
System.String message
System.Exception ex
Returns
Type Description
System.Int16

ExecuteSQL(String, ref Recordset)

Declaration
public void ExecuteSQL(string sql, ref Recordset records)
Parameters
Type Name Description
System.String sql
ADODB.Recordset records

ExecuteSQLNoReturn(String)

Declaration
public void ExecuteSQLNoReturn(string sql)
Parameters
Type Name Description
System.String sql

format_time(Int32)

Declaration
public string format_time(int totalTime)
Parameters
Type Name Description
System.Int32 totalTime
Returns
Type Description
System.String

forward_object(String, String, ref String, String, ref String, Boolean, String)

Declaration
public short forward_object(string objId, string newQueue, ref string forwardDate, string notes, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String newQueue
System.String forwardDate
System.String notes
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

FreeConnection()

Declaration
public void FreeConnection()

get_item(String)

Declaration
public object get_item(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Object

get_next_sn(Int16)

Declaration
public object get_next_sn(short the_ind)
Parameters
Type Name Description
System.Int16 the_ind
Returns
Type Description
System.Object

GetColor(String)

Declaration
public string GetColor(string purpose)
Parameters
Type Name Description
System.String purpose
Returns
Type Description
System.String

GetConfigItem(String, String, Object)

Declaration
public object GetConfigItem(string configItem, string fieldName, object loginName)
Parameters
Type Name Description
System.String configItem
System.String fieldName
System.Object loginName
Returns
Type Description
System.Object

GetCurrentDate()

Declaration
public DateTime GetCurrentDate()
Returns
Type Description
System.DateTime

GetCurrentServerDate()

Declaration
public DateTime GetCurrentServerDate()
Returns
Type Description
System.DateTime

GetItem(String, Int16, Int16, String)

Declaration
public string GetItem(string path, short startItem, short stopItem, string separator)
Parameters
Type Name Description
System.String path
System.Int16 startItem
System.Int16 stopItem
System.String separator
Returns
Type Description
System.String

GetNextNumScheme(String)

Declaration
public string GetNextNumScheme(string numSchemaName)
Parameters
Type Name Description
System.String numSchemaName
Returns
Type Description
System.String

GetNextSubcaseID(String, Int32)

Declaration
public string GetNextSubcaseID(string caseId, int caseConditionId)
Parameters
Type Name Description
System.String caseId
System.Int32 caseConditionId
Returns
Type Description
System.String

GetNextSubcaseID(String, Int32, IDbTransaction)

Declaration
public string GetNextSubcaseID(string caseId, int caseConditionId, IDbTransaction transaction)
Parameters
Type Name Description
System.String caseId
System.Int32 caseConditionId
System.Data.IDbTransaction transaction
Returns
Type Description
System.String

GetNumGenerics()

Declaration
public int GetNumGenerics()
Returns
Type Description
System.Int32

GetObjid(String)

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

GetUserVersion(String)

Declaration
public string GetUserVersion(string formName)
Parameters
Type Name Description
System.String formName
Returns
Type Description
System.String

Init_Object(ref IFCGeneric, String, String, String)

Declaration
public IFCGeneric Init_Object(ref IFCGeneric generic, string objectType, string dataFields, string bulkName)
Parameters
Type Name Description
IFCGeneric generic
System.String objectType
System.String dataFields
System.String bulkName
Returns
Type Description
IFCGeneric

IsUnicode(String)

Declaration
public object IsUnicode(string testString)
Parameters
Type Name Description
System.String testString
Returns
Type Description
System.Object

ItemCount(String, String)

Declaration
public short ItemCount(string path, string separator)
Parameters
Type Name Description
System.String path
System.String separator
Returns
Type Description
System.Int16

LoadColors(String)

Declaration
public void LoadColors(string userName)
Parameters
Type Name Description
System.String userName

LoadUserVersions(Object)

Declaration
public void LoadUserVersions(object userName)
Parameters
Type Name Description
System.Object userName

Log(String, String)

Declaration
public void Log(string messageType, string message)
Parameters
Type Name Description
System.String messageType
System.String message

LogEx(String, String)

Declaration
public void LogEx(string logLevel, string logMessage)
Parameters
Type Name Description
System.String logLevel
System.String logMessage

Login(String, String, String)

Declaration
public void Login(string username, string password, string loginType)
Parameters
Type Name Description
System.String username
System.String password
System.String loginType

LoginFromFCApp()

Declaration
public void LoginFromFCApp()

Logout()

Declaration
public void Logout()

move_object(String, String, String)

Declaration
public short move_object(string objId, string newWipBin, string objectType)
Parameters
Type Name Description
System.String objId
System.String newWipBin
System.String objectType
Returns
Type Description
System.Int16

NewEnum()

Declaration
public IEnumerator NewEnum()
Returns
Type Description
System.Collections.IEnumerator

RefreshContext()

Declaration
public void RefreshContext()

RegisterLicenseRequirements(Int32)

Declaration
[ComVisible(false)]
public void RegisterLicenseRequirements(int productId)
Parameters
Type Name Description
System.Int32 productId

reject_object(String, ref String, String, String, ref String, Boolean, String)

Declaration
public short reject_object(string objId, ref string rejectDate, string wipBin, string notes, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String rejectDate
System.String wipBin
System.String notes
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

RemoveAllGenericsInABulk(String)

Declaration
public void RemoveAllGenericsInABulk(string bulkName)
Parameters
Type Name Description
System.String bulkName

RollbackTransaction()

Declaration
public void RollbackTransaction()

SaveSession()

Declaration
public void SaveSession()

set_item(String, Object)

Declaration
public void set_item(string key, object newValue)
Parameters
Type Name Description
System.String key
System.Object newValue

SetNullStringToEmpty(Object)

Declaration
public object SetNullStringToEmpty(object inputString)
Parameters
Type Name Description
System.Object inputString
Returns
Type Description
System.Object

SetPassword(String, String, String)

Declaration
public void SetPassword(string loginName, string password, string loginType)
Parameters
Type Name Description
System.String loginName
System.String password
System.String loginType

SimpleQuery(ref IFCGeneric, String, String, String)

Declaration
public void SimpleQuery(ref IFCGeneric generic, string objectType, string dataFields, string bulkName)
Parameters
Type Name Description
IFCGeneric generic
System.String objectType
System.String dataFields
System.String bulkName

single_quotify(String)

Declaration
public string single_quotify(string inputString)
Parameters
Type Name Description
System.String inputString
Returns
Type Description
System.String

sprintf(String, Object, Object, Object, Object, Object, Object)

Declaration
public string sprintf(string inputString, object arg1, object arg2, object arg3, object arg4, object arg5, object arg6)
Parameters
Type Name Description
System.String inputString
System.Object arg1
System.Object arg2
System.Object arg3
System.Object arg4
System.Object arg5
System.Object arg6
Returns
Type Description
System.String

StartTransaction(Object)

Declaration
public void StartTransaction(object isolationLevel)
Parameters
Type Name Description
System.Object isolationLevel

TraverseFromParent(ref IFCGeneric, String, String, String, IFCGeneric, String)

Declaration
public IFCGeneric TraverseFromParent(ref IFCGeneric generic, string objectType, string dataFields, string bulkName, IFCGeneric parentGeneric, string relationName)
Parameters
Type Name Description
IFCGeneric generic
System.String objectType
System.String dataFields
System.String bulkName
IFCGeneric parentGeneric
System.String relationName
Returns
Type Description
IFCGeneric

turn_off(Int32, Int32)

Declaration
public int turn_off(int bigNum, int smallNum)
Parameters
Type Name Description
System.Int32 bigNum
System.Int32 smallNum
Returns
Type Description
System.Int32

use_list(IFCGeneric, Object, Object, Object)

Declaration
public void use_list(IFCGeneric generic, object fieldList, object typeList, object valueList)
Parameters
Type Name Description
IFCGeneric generic
System.Object fieldList
System.Object typeList
System.Object valueList

yank_object(String, String, ref String, ref String, Boolean, String)

Declaration
public short yank_object(string objId, string wipBin, ref string yankDate, ref string localUserName, bool generateTimeBombs, string objectType)
Parameters
Type Name Description
System.String objId
System.String wipBin
System.String yankDate
System.String localUserName
System.Boolean generateTimeBombs
System.String objectType
Returns
Type Description
System.Int16

Implements

System.IDisposable