9COM Data Server Quick Reference

COM Data Server Quick Reference

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

• Application Methods for COM Data Server

• Business Component Methods for COM Data Server

• Business Object Methods for COM Data Server

• Business Service Methods for COM Data Server

• Property Set Methods for COM Data Server

Application Methods for COM Data Server

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

Table Summary of Application Methods for COM Data Server

Method	Description	Format
CurrencyCode Method for an Application	Returns the currency code that is associated with the division of the user position.	Dim application as SiebelApplication Dim sCur as String sCur = Application.CurrencyCode(ErrCode as Integer)
GetBusObject Method for an Application	Creates a new instance of a business object.	Dim application as SiebelApplication Dim busObject as SiebelBusObject set busObject = application.GetBusObject(busobjName as String, ErrCode as Integer)
GetLastErrText Method for an Application	Returns the text message for the error that Siebel CRM logged most recently.	Dim application as SiebelApplication Dim sText as String sText = application.GetLastErrText(ErrCode as Integer)
GetProfileAttr Method for an Application	Returns the name of an attribute in a user profile.	Dim application as SiebelApplication Dim sText as String sText = application.GetProfileAttr(Name 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 SiebelApplication Dim Service as SiebelService set Service = Application.GetService(serviceName as String, ErrCode as Integer)
GetSharedGlobal Method for an Application	Returns the shared global variables.	Dim application as SiebelApplication Dim sName as String sName = application.GetSharedGlobal(varName as String, ErrCode as Integer)
InvokeMethod Method for an Application	Calls a method.	Dim application as SiebelApplication application.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)
LoadObjects Method for an Application	Starts the COM Data Server.	Dim application as SiebelApplication application.LoadObjects(pathName\cfgFileName as String, ErrCode as Integer)
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 SiebelApplication application.Login(userName as String, password as String, ErrCode as Integer)
LoginId Method for an Application	Returns the login ID of the user who started the Siebel application.	Dim application as SiebelApplication Dim sID as String sID = application.LoginId(ErrCode as Integer)
LoginName Method for an Application	Returns the login name of the user who started the Siebel application.	Dim application as SiebelApplication Dim sUser as String sUser = application.LoginName(ErrCode as Integer)
NewPropertySet Method for an Application	Creates a new property set.	Dim oApplication as SiebelApplication Dim oPropSet as SiebelPropertySet oPropSet = oApplication.NewPropertySet()
PositionId Method for an Application	Returns the position ID of the user position.	Dim application as SiebelApplication Dim sRow as String sRow = application.PositionId(ErrCode asInteger)
PositionName Method for an Application	Returns the name of the current user position.	Dim application as SiebelApplication Dim sPosition as String sPosition = application.PositionName(ErrCode as Integer)
SetPositionId Method for an Application	Sets the active position to a position ID.	Dim application as SiebelApplication Dim posId as String Dim status as Boolean status = application.SetPositionId(posId as String, ErrCode as Integer)
SetPositionName Method for an Application	Sets the active position to a position name.	Dim application as SiebelApplication Dim posName as String Dim status as Boolean status = application.SetPositionName(posName as String, ErrCode as Integer)
SetProfileAttr Method for an Application	Personalization uses this method to set a value for an attribute in a user profile.	Dim application as SiebelApplication application.SetProfileAttr(name as String, value as String, ErrCode as Integer)
SetSharedGlobal Method for an Application	Sets a shared global variable.	Dim application as SiebelApplication application.SetSharedGlobal(varName as String, value as String, ErrCode as Integer)
Trace Method for an Application	Appends a message to the trace file.	Dim application as SiebelApplication application.Trace(message as String, ErrCode as Integer)
TraceOff Method for an Application	Turns off tracing.	Dim application as SiebelApplication application.TraceOff(ErrCode as Integer)
TraceOn Method for an Application	Turns on tracing.	Dim application as SiebelApplication application.TraceOn(filename as String, type as Integer, Selection as String, ErrCode as Integer)

Business Component Methods for COM Data Server

The following table describes a summary of the business component methods you can use with the COM Data Server. It does not include object interface methods that Siebel CRM calls with the InvokeMethod method. 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 Server

Method	Description	Format
ActivateField Method for a Business Component	Activates a field.	Dim busComp as SiebelBusComp busComp.ActivateField(fieldName as String, ErrCode as Integer)
ActivateMultipleFields Method for a Business Component	Activates multiple fields.	Dim buscomp as SiebelBusComp buscomp.ActivateMultipleFields(oPropSet as SiebelPropertySet, ErrCode as Integer)
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, ErrCode 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 BusObject Set busObject = busComp.BusObject(ErrCode as Integer)
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(ErrCode as Integer)
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(ErrCode as Integer)
DeleteRecord Method for a Business Component	Removes the current record from a business component.	Dim busComp as SiebelBusComp busComp.DeleteRecord(ErrCode as Integer)
ExecuteQuery Method for a Business Component	Returns a set of business component records.	Dim busComp as SiebelBusComp busComp.ExecuteQuery(cursorMode as Boolean, ErrCode as Integer)
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 Boolean, ignoreMaxCursorSize as Boolean, ErrCode as Integer)
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(ErrCode as Integer)
FirstSelected Method for a Business Component	Makes the first record of the multiple selection in a business component active.	Dim busComp as SiebelBusComp Dim iRecord as Integer iRecord = busComp.FirstSelected
GetAssocBusComp Method for a Business Component	Returns the name of the association business component.	Dim busComp as SiebelBusComp Dim AssocBusComp as BusComp Set AssocBusComp = busComp.GetAssocBusComp(ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
GetMultipleFieldValues Method for a Business Component	Returns a value for each field specified in a property set.	Dim buscomp as SiebelBusComp Dim retValue as Boolean retValue = buscomp.GetMultipleFieldValues(oPropSetName as SiebelPropertySet, oPropSetValue as SiebelPropertySet, ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
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(FieldName as String, ErrCode as Integer)
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(ErrCode as Integer)
GetSearchSpec Method for a Business Component	Returns the search specification that is defined for a business component.	Dim busComp as BusComp Dim sSpec as String sSpec = busComp.GetSearchSpec(FieldName as String, ErrCode as Integer)
GetUserProperty Method for a Business Component	Returns the value of a user property.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetUserProperty(propertyName as String, ErrCode as Integer)
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(ErrCode as Integer)
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(ErrCode as Integer)
Name Method for a Business Component	Returns the name of a business component.	Dim busComp as SiebelBusComp Dim sName as String sName = busComp.Name(ErrCode as Integer)
NewRecord Method for a Business Component	Adds a new record to a business component.	Dim busComp as SiebelBusComp busComp.NewRecord(whereIndicator as Integer, ErrCode 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(ErrCode as Integer)
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(ErrCode as Integer)
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(ErrCode as Integer)
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(ErrCode as Integer)
RefineQuery Method for a Business Component	Refines a query.	Dim busComp as SiebelBusComp busComp.RefineQuery(ErrCode as Integer)
SetFieldValue Method for a Business Component	Sets a new value in a field for the current record of a business component.	Dim busComp as SiebelBusComp SetFieldValue(fieldname As String, fieldValue As string,errCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
SetNamedSearch Method for a Business Component	Sets a named search specification on a business component.	Dim busComp as SiebelBusComp busComp.SetNamedSearch(searchName as String, searchSpec as String, ErrCode as Integer)
SetSearchExpr Method for a Business Component	Sets a search expression for a business component.	Dim busComp as SiebelBusComp busComp.SetSearchExpr(searchSpec as String, ErrCode as Integer)
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, ErrCode as Integer)
SetSortSpec Method for a Business Component	Sets the sort specification for a business component.	Dim busComp as SiebelBusComp busComp.SetSortSpec(sortSpec as String, ErrCode as Integer)
SetUserProperty Method for a Business Component	Sets the value of a user property in a business component.	Dim busComp as SiebelBusComp busComp.SetUserProperty(propertyName as String, newValue as String, ErrCode as Integer)
SetViewMode Method for a Business Component	Sets the visibility type for a business component.	Dim buscomp as SiebelBusComp buscomp.SetViewMode(mode As Integer, errCode As Integer)
UndoRecord Method for a Business Component	Reverses any unsaved modifications made to the record.	Dim busComp as SiebelBusComp busComp.UndoRecord(ErrCode as Integer)
WriteRecord Method for a Business Component	Saves to the Siebel database any modifications made to the current record.	Dim busComp as SiebelBusComp busComp.WriteRecord(ErrCode as Integer)

Business Object Methods for COM Data Server

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

Table Summary of Business Object Methods for COM Data Server

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, ErrCode as Integer)
Name Method for a Business Object	Returns the name of a control.	Dim busObject as SiebelBusObject Dim sName as String sName = busObject.Name(ErrCode as Integer)

Business Service Methods for COM Data Server

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

Table Summary of Business Service Methods for COM Data Server

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(ErrCode as Integer)
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(ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)

Property Set Methods for COM Data Server

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

Table Summary of Property Set Methods for COM Data Server

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, errCode as Integer)
Copy Method for a Property Set	Returns a copy of a property set.	Dim oPropSet1 as SiebelPropertySet Dim oPropSet2 as SiebelPropertySet oPropSet2 = oPropSet1.Copy(ErrCode as Integer)
GetChild Method for a Property Set	Returns a child property set of a property set.	Dim oPropSet as SiebelPropertySet Dim oChildPropSet as SiebelPropertySet oChildPropSet = oPropSet.GetChild( index as Integer, ErrCode 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(ErrCode as Integer)
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(ErrCode as Integer)
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(ErrCode as Integer)
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, ErrCode as Integer)
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 propCount as Integer propCount = oPropSet.GetPropertyCount (ErrCode as Integer)
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(value as String)
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(ErrCode as Integer)
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 String, index as Integer, ErrCode as Integer)
PropertyExists Method for a Property Set	Returns a Boolean value that indicates if the property that the argument identifies exists.	Dim oPropSet as SiebelPropertySet Dim propExists as Boolean propExists = oPropSet.PropertyExists( propName as String, ErrCode as Integer)
RemoveChild Method for a Property Set	Removes a child property set from a parent property set.	Dim oPropSet as SiebelPropertySet oPropSet.RemoveChild(index as Integer, errCode as Integer)
RemoveProperty Method for a Property Set	Removes a property from a property set.	Dim oPropSet as SiebelPropertySet oPropSet.RemoveProperty(propName as String, ErrCode as Integer)
Reset Method for a Property Set	Removes every property and child property set from a property set.	Dim oPropSet as SiebelPropertySet oPropSet.Reset(ErrCode as Integer)
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, ErrCode as Integer)
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, ErrCode as Integer)
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, errCode as Integer)