10COM Data Control Quick Reference

COM Data Control Quick Reference

This chapter describes summary information for COM Data Control. It includes the following topics:

• Application Methods for COM Data Control

• Business Component Methods for COM Data Control

• Business Object Methods for COM Data Control

• Business Service Methods for COM Data Control

• Property Set Methods for COM Data Control

Application Methods for COM Data Control

The following table describes a summary of application methods you can use with COM Data Control. It does not include object interface methods that Siebel CRM does not call directly from an application instance. For information about methods that Siebel CRM calls with the InvokeMethod method on the application object, see LoadObjects Method for an Application.

Table Summary of Application Methods for COM Data Control

Method	Description	Format
Attach Method for an Application	Allows an external application to reconnect to an existing Siebel session.	Dim application as SiebelDataControl Dim status as Boolean status = application.Attach(sessionID As String)
CurrencyCode Method for an Application	Returns the currency code that is associated with the division of the user position.	Dim application as SiebelDataControl Dim sCur as String sCur = Application.CurrencyCode
Detach Method for an Application	Returns a string that contains the Siebel session ID.	Dim application as SiebelDataControl Dim sessionId as String sessionId = application.Detach()
EnableExceptions Method for an Application	Enables or disables native Component Object Model (COM) error handling.	Dim application as SiebelDataControl Dim bEnable as Boolean bEnable = trueapplication.EnableExceptions(bEnable)
GetBusObject Method for an Application	Creates a new instance of a business object.	Dim application as SiebelDataControl Dim busObject as SiebelBusObject set busObject = application.GetBusObject(busobjName as String)
GetLastErrCode Method for an Application	Returns the error code for the error that Siebel CRM logged most recently.	Dim application as SiebelDataControl Dim iErr as Integer iErr = application.GetLastErrCode
GetLastErrText Method for an Application	Returns the text message for the error that Siebel CRM logged most recently.	Dim application as SiebelDataControl Dim sText as String sText = application.GetLastErrText
GetProfileAttr Method for an Application	Returns the name of an attribute in a user profile.	Dim application as SiebelDataControl Dim sText as String sText = application.GetProfileAttr(profileAttributeName as string)
GetService Method for an Application	Locates a business service. If this business service is not already running, then Siebel CRM starts it.	Dim application as SiebelDataControl Dim service as SiebelService set service = application.GetService(serviceName as String)
GetSharedGlobal Method for an Application	Returns the shared global variables.	Dim application as SiebelDataControl Dim sText as string sText = application.GetSharedGlobal(globalVariableName as string)
InvokeMethod Method for an Application	Calls a method.	Dim application as SiebelDataControl Dim sReturn as String sReturn = application.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)
Login Method for an Application	Allows an external application to log in to the COM Data Server, COM Data Control, or Siebel Java Data Bean, and to access Siebel objects.	Dim application as SiebelDataControl Dim sErr as String sErr = application.Login(connectString as String, userName as String, password as String)
LoginId Method for an Application	Returns the login ID of the user who started the Siebel application.	Dim application as SiebelDataControl Dim sID as String sID = application.LoginId
LoginName Method for an Application	Returns the login name of the user who started the Siebel application.	Dim application as SiebelDataControl Dim sUser as String sUser = application.LoginName
Logoff Method for an Application	Disconnects the Siebel client from the Siebel Server.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.LogOff
NewPropertySet Method for an Application	Creates a new property set.	Dim application as SiebelDataControl Dim PropSet as SiebelPropertySet PropSet = oApplication.NewPropertySet
PositionId Method for an Application	Returns the position ID of the user position.	Dim application as SiebelDataControl Dim sRow as String sRow = application.PositionId
PositionName Method for an Application	Returns the name of the current user position.	Dim application as SiebelDataControl Dim sPosition as String sPosition = application.PositionName
SetPositionId Method for an Application	Sets the active position to a Position ID.	Dim application as SiebelDataControl Dim status as Boolean status = application.SetPositionId(sPosId)
SetPositionName Method for an Application	Sets the active position to a position name.	Dim application as SiebelDataControl Dim status as Boolean status = application.SetPositionName(sPosName)
SetProfileAttr Method for an Application	Personalization uses this method to set a value for an attribute in a user profile.	Dim application as SiebelDataControl application.SetProfileAttr(name as String, value as String)
SetSharedGlobal Method for an Application	Sets a shared global variable.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = SiebApp.SetSharedGlobal(varName As String, value As String)
Trace Method for an Application	Appends a message to the trace file.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.TraceOn(msg As String)
TraceOff Method for an Application	Turns off tracing.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal=siebApp.TraceOff
TraceOn Method for an Application	Turns on tracing.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.TraceOn(fileName As String, category As String, src As String)

Business Component Methods for COM Data Control

The following table describes a summary of business component methods you can use with COM Data Control. It does not include object interface methods that Siebel CRM does not call directly from a business component instance. For information about methods that Siebel CRM calls with the InvokeMethod method on a business component, see Business Component Invoke Methods.

Table Summary of Business Component Methods for COM Data Control

Method	Description	Format
ActivateField Method for a Business Component	Activates a field.	Dim busComp as SiebelBusComp BusComp.ActivateField(fieldName as String)
ActivateMultipleFields Method for a Business Component	Activates multiple fields.	Dim busComp as SiebelBusComp busComp.ActivateMultipleFields(oPropSet as SiebelPropertySet)
Associate Method for a Business Component	Creates a new many-to-many relationship for the parent object through an association business component.	Dim busComp as SiebelBusComp busComp.Associate(whereIndicator as Integer)
BusObject Method for a Business Component	Returns the name of the business object that the business component references.	Dim busComp as SiebelBusComp Dim busObject as SiebelBusObject Set busObject = busComp.BusObject
ClearToQuery Method for a Business Component	Clears the current query but does not clear sort specifications on a business component.	Dim busComp as SiebelBusComp busComp.ClearToQuery
DeactivateFields Method for a Business Component	Deactivates the fields that are currently active from the SQL query statement of a business component.	Dim busComp as SiebelBusComp busComp.DeactivateFields
DeleteRecord Method for a Business Component	Removes the current record from a business component.	Dim busComp as SiebelBusComp busComp.DeleteRecord
ExecuteQuery Method for a Business Component	Returns a set of business component records.	Dim buscomp as SiebelBusComp buscomp.ExecuteQuery(cursorMode As Integer) As Boolean
ExecuteQuery2 Method for a Business Component	Returns a set of business component records. Allows you to control the number of records Siebel CRM returns.	Dim buscomp as SiebelBusComp buscomp.ExecuteQuery2(cursorMode As Integer,ignoreMaxCursorSize As Integer) As Boolean
FirstRecord Method for a Business Component	Moves the record pointer to the first record in a business component, making that record the current record.	Dim busComp as SiebelBusComp Dim bIsRecord as Boolean bIsRecord = busComp.FirstRecord
GetFieldValue Method for a Business Component	Returns the value of a field from the current record of a business component.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFieldValue(FieldName as String)
GetFormattedFieldValue Method for a Business Component	Returns a field value that is in the same format that the Siebel client uses.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFormattedFieldValue (FieldName as String)
GetLastErrCode Method for a Business Component	Returns the error code for the error that Siebel CRM logged most recently.	Dim errCode As Integer Dim SiebApp as SiebelDataControl errCode=siebApp.GetLastErrCode
GetLastErrText Method for an Application	Returns the text message for the error that Siebel CRM logged most recently.	Dim busComp as SiebelBusComp Dim sErr as String sErr = busComp.GetLastErrText
GetMultipleFieldValues Method for a Business Component	Returns a value for each field specified in a property set.	Dim busComp as SiebelBusComp busComp.GetMultipleFieldValues(oFieldNames as SiebelPropertySet, oFieldValues as SiebelPropertySet)
GetMVGBusComp Method for a Business Component	Returns the multivalue group business component that is associated a business component field.	Dim busComp as SiebelBusComp Dim mVGBusComp as SiebelBusComp set mVGBusComp = busComp.GetMVGBusComp(FieldName as String)
GetNamedSearch Method for a Business Component	Returns the name of a search specification.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetNamedSearch(SearchName as String)
GetPicklistBusComp Method for a Business Component	Returns the name of the pick business component that is associated with a field in the current business component.	Dim busComp as SiebelBusComp Dim pickBusComp as SiebelBusComp Set pickBusComp = busComp.GetPicklistBusComp(Field-Name as String)
GetSearchExpr Method for a Business Component	Returns the current search expression that is defined for a business component.	Dim busComp as SiebelBusComp Dim sExpr as String sExpr = busComp.GetSearchExpr
GetSearchSpec Method for a Business Component	Returns the search specification that is defined for a business component.	Dim busComp as SiebelBusComp Dim sSpec as String sSpec = busComp.GetSearchSpec(FieldName as String)
GetUserProperty Method for a Business Component	Returns the value of a user property.	Dim buscomp as SiebelBusComp Dim retStr as String retStr = buscomp.GetUserProperty(prop As String) As String
GetViewMode Method for a Business Component	Returns the visibility mode for a business component.	Dim busComp as SiebelBusComp Dim iMode as Integer iMode = busComp.GetViewMode
InvokeMethod Method for a Business Component	Calls a method.	Dim busComp as SiebelBusComp Dim sReturn as String sReturn = busComp.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)
LastRecord Method for a Business Component	Moves the record pointer to the last record in a business component.	Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.LastRecord
Name Method for a Business Component	Returns the name of a business component.	Dim busComp as SiebelBusComp Dim sName as String sName = busComp.Name
NewRecord Method for a Business Component	Adds a new record to a business component.	Dim busComp as SiebelBusComp busComp.NewRecord(whereIndicator as Integer)
NextRecord Method for a Business Component	Moves the record pointer to the next record in a business component, making that record the current record.	Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.NextRecord
ParentBusComp Method for a Business Component	Returns the name of a parent business component.	Dim busComp as SiebelBusComp Dim parentBusComp as SiebelBusComp Set parentBusComp = busComp.ParentBusComp
Pick Method for a Business Component	Places the currently chosen record in a pick business component into the appropriate fields of the parent business component.	Dim busComp as SiebelBusComp busComp.Pick
PreviousRecord Method for a Business Component	Moves the record pointer to the previous record in a business component, making that record the current record.	Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.PreviousRecord
RefineQuery Method for a Business Component	Refines a query.	Dim busComp as SiebelBusComp busComp.RefineQuery
SetFieldValue Method for a Business Component	Sets a new value in a field in the current record of a business component.	Dim busComp as SiebelBusComp busComp.SetFieldValue(FieldName as String, FieldValue as String)
SetFormattedFieldValue Method for a Business Component	Sets a new value in a field in the current record of a business component. It accepts the field value in the current local format.	Dim busComp as SiebelBusComp busComp.SetFormattedFieldValue(FieldName as String, FieldValue as String)
SetMultipleFieldValues Method for a Business Component	Sets new values in the fields of the current record of a business component.	Dim busComp as SiebelBusComp busComp.SetMultipleFieldValues(oPropSet as SiebelPropertySet)
SetNamedSearch Method for a Business Component	Sets a named search specification on a business component.	Dim busComp as SiebelBusComp busComp.SetNameSearch(searchName as String, searchSpec as String)
SetSearchExpr Method for a Business Component	Sets a search expression for a business component.	Dim busComp as SiebelBusComp busComp.SetSearchExpr(searchSpec as String)
SetSearchSpec Method for a Business Component	Sets the search specification for a business component.	Dim busComp as SiebelBusComp busComp.SetSearchSpec(FieldName as String, searchSpec as String)
SetSortSpec Method for a Business Component	Sets the sort specification for a business component.	Dim busComp as SiebelBusComp busComp.SetSortSpec(sortSpec as String)
SetUserProperty Method for a Business Component	Sets the value of a named user property.	Dim buscomp as SiebelBusComp buscomp.SetUserProperty(property-Name as String, newValue as String)
SetViewMode Method for a Business Component	Sets the visibility type for a business component.	Dim buscomp as SiebelBusComp Dim boolVal as Boolean boolVal = buscomp.SetViewMode(mode As Integer)
UndoRecord Method for a Business Component	Reverses any unsaved modifications made to the record.	Dim busComp as SiebelBusComp busComp.UndoRecord
WriteRecord Method for a Business Component	Saves to the Siebel database any modifications made to the current record.	Dim busComp as SiebelBusComp busComp.WriteRecord

Business Object Methods for COM Data Control

The following table describes a summary of business object methods you can use with COM Data Control.

Table Summary of Business Object Methods for COM Data Control

Method	Description	Format
GetBusComp Method for a Business Object	Returns the name of a business component.	Dim busObject as SiebelBusObject Dim busComp as SiebelBusComp set busComp = BusObject.GetBusComp(BusCompName as String)
GetLastErrCode Method for a Business Object	Returns the error code for the error that Siebel CRM logged most recently.	Dim busObject as SiebelBusObject Dim iErr as Integer iErr = busObject.GetLastErrCode
GetLastErrText Method for a Business Object	Returns the text message for the error that Siebel CRM logged most recently.	Dim busObject as SiebelBusObject Dim sErr as String sErr = busObject.GetLastErrText
Name Method for a Business Object	Returns the name of a control.	Dim busObject as SiebelBusObject Dim sName as String sName = busObject.Name

Business Service Methods for COM Data Control

The following table describes a summary of business service methods you can use with COM Data Control.

Table Summary of Business Service Methods for COM Data Control

Method	Description	Format
GetFirstProperty Method for a Business Service	Returns the name of the first property of a business service.	Dim oService as SiebelService Dim sName as String sName = oService.GetFirstProperty()
GetNextProperty Method for a Business Service	Returns the name of the next property of a business service.	Dim oService as SiebelService Dim sName as String sName = oService.GetNextProperty()
GetProperty Method for a Business Service	Returns the value of a property.	Dim oService as SiebelService Dim sValue as String sValue = oService.GetProperty(propName as String)
Name Method for a Business Service	Returns the name of a business service.	Dim oService as SiebelService Dim sName as String sName = oService.Name
InvokeMethod Method for a Business Service	Calls a method.	Dim oService as SiebelService oService.InvokeMethod(methodName as String, InputArguments as SiebelPropertySet, OutputArguments as SiebelPropertySet)
PropertyExists Method for a Business Service	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oService as SiebelService Dim propExists as Boolean propExists = oService.PropertyExists(propName as String)
RemoveProperty Method for a Business Service	Removes a property from a business service.	Dim oService as SiebelService oService.RemoveProperty(propName as String)
SetProperty Method for a Business Service	Sets a value for a property of a business service.	Dim oService as SiebelService oService.SetProperty(propName as String, propValue as String)

Property Set Methods for COM Data Control

The following table describes a summary of property set methods you can use with COM Data Control.

Table Summary of Property Set Methods for COM Data Control

Method	Description	Format
AddChild Method for a Property Set	Adds child property sets to a property set.	Dim oPropSet as SiebelPropertySet Dim iIndex as Integer iIndex = oPropSet.AddChild(childObject as Property Set)
Copy Method for a Property Set	Returns a copy of a property set.	Dim oPropSet1 as SiebelPropertySet Dim oPropSet2 as SiebelPropertySet oPropSet2 = oPropSet1.Copy()
GetChild Method for a Property Set	Returns a child property set of a property set.	Dim oPropSet as SiebelPropertySet Dim oPropSet1 as SiebelPropertySet oPropSet1 = oPropSet.GetChild(index as Integer)
GetChildCount Method for a Property Set	Returns the number of child property sets that exist for a parent property set.	Dim oPropSet as SiebelPropertySet Dim iCount as Integer iCount = oPropSet.GetChildCount()
GetFirstProperty Method for a Property Set	Returns the name of the first property in a property set.	Dim oPropSet as SiebelPropertySet Dim sPropName as String sPropName = oPropSet.GetFirstProperty()
GetNextProperty Method for a Property Set	Returns the name of the next property in a property set.	Dim oPropSet as SiebelPropertySet Dim sPropName as String sPropName = oPropSet.GetNextProperty()
GetProperty Method for a Property Set	Returns the value of a property.	Dim oPropSet as SiebelPropertySet Dim sPropVal as String sPropVal = oPropSet.GetProperty(propName as String)
GetPropertyCount Method for a Property Set	Returns the number of properties that exist in the current level in the hierarchy.	Dim oPropSet as SiebelPropertySet Dim count as Long count = oPropSet.GetPropertyCount
GetType Method for a Property Set	Returns the value of the type attribute of a property set.	Dim oPropSet as SiebelPropertySet Dim sTypeVal as String sTypeVal = oPropSet.GetType()
GetValue Method for a Property Set	Returns the value of the value attribute of a property set.	Dim oPropSet as SiebelPropertySet Dim sValVal as String sValVal = oPropSet.GetValue()
InsertChildAt Method for a Property Set	Inserts a child property set in a parent property set at a specific location.	Dim oPropSet as SiebelPropertySet oPropSet.InsertChildAt(childObject as SiebelPropertySet, index as Long)
PropertyExists Method for a Property Set	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oPropSet as Property Set Dim propExists as Boolean propExists = oPropSet.PropertyExists(propName as String)
RemoveChild Method for a Property Set	Removes a child property set from a parent property set.	Dim oPropSet as SiebelPropertySet oPropSet.RemoveChild(index as Long)
RemoveProperty Method for a Property Set	Removes a property from a property set.	Dim oPropSet as SiebelPropertySet oPropSet.RemoveProperty(propName as String)
Reset Method for a Property Set	Removes every property and child property set from a property set.	Dim oPropSet as SiebelPropertySetoPropSet.Reset()
SetProperty Method for a Property Set	Sets a value in the property of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetProperty(propName as String, propValue as String)
SetType Method for a Property Set	Sets the value for the type attribute of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetType(value as String)
SetValue Method for a Property Set	Sets the value for the value attribute of a property set.	Dim oPropSet as SiebelPropertySet oPropSet.SetValue(value as String)