Siebel Object Interfaces Reference > COM Data Server Quick Reference >

Property Set Methods for COM Data Server


Table 45 lists a summary of the property set methods' syntax.

Table 45. Property Set Methods Syntax Summary
Method
Description
Syntax

AddChild Method

Adds subsidiary 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

Returns a copy of a property set.

Dim oPropSet1 as SiebelPropertySet
Dim oPropSet2 as SiebelPropertySet
oPropSet2 = oPropSet1.Copy(ErrCode as Integer)

GetChild Method

Returns a specified 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

Returns the number of child property sets attached to a parent property set.

Dim oPropSet as SiebelPropertySet
Dim iCount as Integer
iCount = oPropSet.GetChildCount(ErrCode as Integer)

GetFirstProperty Method

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

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

Returns the value of a property when given the property name.

Dim oPropSet as SiebelPropertySet
Dim sPropVal as String
sPropVal = oPropSet.GetProperty(propName as String, ErrCode as Integer)

GetPropertyCount Method

Returns the number of properties contained within the property set.

Dim oPropSet as SiebelPropertySet
Dim propCount as Integer
propCount = oPropSet.GetPropertyCount (ErrCode as Integer)

GetType Method

Returns the value stored in a type in a property set.

Dim oPropSet as SiebelPropertySet
Dim sTypeVal as String
sTypeVal = oPropSet.GetType(value as String)

GetValue Method

Returns a value stored as part of a property set.

Dim oPropSet as SiebelPropertySet
Dim sValVal as String
sValVal = oPropSet.GetValue(ErrCode as Integer)

InsertChildAt Method

Inserts a child property set into 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

Returns a Boolean value indicating whether the property specified in the argument exists.

Dim oPropSet as SiebelPropertySet
Dim propExists as Boolean
propExists = oPropSet.PropertyExists( propName as String, ErrCode as Integer)

RemoveChild Method

Removes a child property set as a specified index from a parent property set.

Dim oPropSet as SiebelPropertySet
oPropSet.RemoveChild(index as Integer, errCode as Integer)

RemoveProperty Method

Removes the property specified in its argument from a property set.

Dim oPropSet as SiebelPropertySet
oPropSet.RemoveProperty(propName as String, ErrCode as Integer)

Reset Method

Removes every property and child property set from a property set.

Dim oPropSet as SiebelPropertySet
oPropSet.Reset(ErrCode as Integer)

SetProperty Method

Assigns a value to the property of a property set specified in its argument.

Dim oPropSet as SiebelPropertySet
oPropSet.SetProperty(propName as String, propValue as String, ErrCode as Integer)

SetType Method

Assigns a data value to a type member of a property set.

Dim oPropSet as SiebelPropertySet
oPropSet.SetType(value as String, ErrCode as Integer)

SetValue Method

Assigns a data value to a value member of a property set.

Dim oPropSet as SiebelPropertySet
oPropSet.SetValue(value as String, errCode as Integer)

Siebel Object Interfaces Reference Copyright © 2008, Oracle. All rights reserved.