Bookshelf Home | Contents | Index | PDF | ![]() ![]() |
Siebel Object Interfaces Reference > Siebel Object Interfaces Reference > Object Interfaces Reference > Property Set MethodsThis topic describes property set methods. It includes the following topics:
In this topic, the oPropSet variable indicates the variable that contains a property set. AddChild Method for a Property SetThe AddChild method adds a child property set to a property set. This method returns an integer that indicates the index of the child property set. FormatoPropSet.AddChild(childPropSet) Table 95 describes the arguments for the AddChild method.
UsageYou can use a property set to create a tree data structure. You can add any number of arbitrarily structured child properties to a property set. You can use a child property set to structure a property set in a manner that is similar to the structure that the data model uses. For example, a parent account property set can include child property sets for opportunities, contacts, activities, and so forth. In this example, you could create an independent property set named Opportunity, where accounts, contacts, and activities can be children. If Siebel CRM creates an instance of a property set through script, and then adds it to a parent property set, and if the parent property set is subsequently released, then Siebel CRM does not release this child instance. The reference to the child instance exists independently. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThe following fragment of Siebel eScript code adds child property sets to a parent property set: var Account = TheApplication().NewPropertySet(); Account.AddChild(Opportunity); Related TopicsFor more information, see the following topics:
Copy Method for a Property SetThe Copy method returns a copy of a property set. FormatUsageThe Copy method creates a copy of a property set, including any properties and child property sets. Siebel CRM typically passes a property set through a reference, so making a copy allows you to manipulate a property set without affecting the original property set. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThe following Siebel VB example uses a copy of a property set to store the original values of the properties, and displays the original and Pig-Latin forms of the properties: (general) Function PigLatin (Name1 As String) As String Dim Inputs As PropertySet, Outputs As PropertySet Inputs.SetProperty "Name", "Harold" propName = Outputs.GetFirstProperty() Set message = Nothing GetByteValue Method for a Property SetThe GetByteValue method returns the following information:
For more information, see SetByteValue Method for a Property Set. FormatUsed WithExamplesThe following example uses a binary value as input and provides a binary output. The angle brackets (< >) indicate a variable: SiebelPropertySet input = new SiebelPropertySet(); input.setProperty("ProcessName", "LMS3 Jason"); // XML to send // convert string to byte array input.setByteValue(bvalue); // Use getByteValue to return the value..and pop it in a String..for example GetChild Method for a Property SetThe GetChild method returns the index number of a child property set. FormatTable 96 describes the arguments for the GetChild method.
How Siebel CRM Handles Indexing for Child Property SetsNote how Siebel CRM handles indexing for a child property set you add, insert, or remove:
Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server If you use the Web Client Automation Server, then the child object that Siebel CRM returns is a copy of the object. Siebel CRM updates any modifications that occur to the object that it returns, but it does not update the originating object. ExamplesThe following Siebel eScript example sets the Name property of child property sets to the same value: function Test1_Click () Account.AddChild(Opportunity); for (var i = 0; i < Account.GetChildCount(); i++) Related TopicsFor more information, see the following topics: GetChildCount Method for a Property SetThe GetChildCount method returns the number of child property sets that exist for a parent property set. FormatUsageThe GetChildCount method returns the number of child property sets for the property set that the oPropSet variable identifies. The index number for child property sets start at 0, so a child count of 3 indicates that there are child property sets at indexes 0, 1, and 2. The GetChildCount method returns only the number of direct descendants. If a child property set includes children, then Siebel CRM does not include these grandchildren in the count that it provides in the return value. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesFor an example, see GetChild Method for a Property Set. GetFirstProperty Method for a Property SetThe GetFirstProperty method for a property set returns a string that contains the name of the first property in a property set. FormatUsageThe usage for the GetFirstProperty method for a property set is similar to the usage for the GetFirstProperty method for a business service. For more information, see Usage for a Method that Gets a Business Service Property. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThe following example uses the GetFirstProperty method to get the first property, and then uses the GetNextProperty method to return all subsequent properties. If the GetNextProperty method returns a null value, then Siebel CRM terminates the loop: function Service_PreInvokeMethod (MethodName, Inputs, Outputs) propName = Inputs.GetFirstProperty(); // stay in loop if the property name is not an empty string // if a property with the same name does not exist propName = Inputs.GetNextProperty(); Related TopicsFor more information, see the following topics: GetLastErrCode Method for a Property SetThe GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error. FormatUsageFor more information, see Usage for the GetLastErrCode Method. Used WithMobile Web Client Automation Server, Web Client Automation Server GetLastErrText Method for a Property SetThe GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently. FormatUsageFor more information, see Usage for the GetLastErrText Method. Used WithMobile Web Client Automation Server, Web Client Automation Server GetNextProperty Method for a Property SetThe GetNextProperty method returns a string that contains the name of the next property of a property set. If no more properties exist, then this method returns an empty string. FormatUsageUsage for the GetNextProperty method for a property set is similar to the usage for the GetNextProperty method for a business service. For more information, see Usage for the GetNextProperty Method. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesFor an example, see GetFirstProperty Method for a Property Set. Related TopicsFor more information, see the following topics: GetProperty Method for a Property SetThe GetProperty method returns a string that contains the value of a property. If the property does not exist, then this method returns NULL. FormatoPropSet.GetProperty(propName) The arguments you can use with this format are the same as the arguments described in Table 83. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThe following fragment of Siebel eScript code receives a set of input properties used with the Shipping Engine business service described in Service_PreInvokeMethod Event: var sShipper = Inputs.GetProperty("Shipping Company"); Related TopicsFor more information, see the following topics:
GetPropertyCount Method for a Property SetThe GetPropertyCount method returns the number of properties that exist in the current level in the hierarchy. It does not return all properties in the entire property set hierarchy. FormatUsed WithBrowser Script, COM Data Control, COM Data Server, Mobile Web Client Automation Server, Server Script, Web Client Automation Server GetType Method for a Property SetThe GetType method returns a string that contains the value of the type attribute of a property set. FormatUsed WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server Related TopicsFor more information, see the following topics: GetValue Method for a Property SetThe GetValue method returns a string that contains the value of the value attribute of a property set. FormatUsed WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server Related TopicsFor more information, see the following topics:
InsertChildAt Method for a Property SetThe InsertChildAt method inserts a child property set in a parent property set at a specific location. This method does not return any information. For more information, see AddChild Method for a Property Set. FormatoPropSet.InsertChildAt childObject, index Table 97 describes the arguments for the InsertChildAt method. UsageFor more information, see How Siebel CRM Handles Indexing for Child Property Sets. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server PropertyExists Method for a Property SetThe description of the PropertyExists method for a property set is the same as the description of the PropertyExists method for a business service. For more information, see PropertyExists Method for a Business Service. FormatoPropSet.PropertyExists(propName) The arguments you can use with this format are the same as the arguments described in Table 85. UsageThe GetProperty method returns an empty string for every nonexistent property, so you can use the PropertyExists method in an If statement to determine if a specific property is set. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesFor an example, see GetFirstProperty Method for a Property Set. RemoveChild Method for a Property SetThe RemoveChild method removes a child property set from a parent property set. This method does not return any information. FormatTable 98 describes the arguments for the RemoveChild method.
UsageFor more information, see How Siebel CRM Handles Indexing for Child Property Sets. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThe following Siebel VB code fragment removes every child property set of a property set: Dim i As Integer Related TopicsFor more information, see the following topics: RemoveProperty Method for a Property SetThe RemoveProperty method removes a property from a property set. This method does not return any information. FormatoPropSet.RemoveProperty propName The arguments you can use with this format are the same as the arguments described in Table 86. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server Reset Method for a Property SetThe Reset method removes all properties and children from a property set. This method does not return any information. FormatUsageThe Reset method allows you to reuse a property set. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server SetByteValue Method for a Property SetThe SetByteValue method sets the value of a property set. This method does not return any information. FormatTable 99 describes the arguments for the SetByteValue method.
Used WithExamplesThe following example uses a binary value as input and then provides a binary output. For more information, see GetByteValue Method for a Property Set: SiebelPropertySet input = new SiebelPropertySet(); input.setProperty("ProcessName", "LMS3 Jason"); // XML to send // convert string to byte array input.setByteValue(bvalue); // use getByteValue to return the value and put it in a String SetProperty Method for a Property SetThe SetProperty method sets a value in the property of a property set. This method does not return any information. For more information, see GetProperty Method for a Property Set. FormatoPropSet.SetProperty propName, propValue The arguments you can use with this format are the same as the arguments described in Table 87. Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server ExamplesThis Siebel VB fragment uses the Shipping Engine business service: Dim Svc As Service With Inputs For more information, see Service_PreInvokeMethod Event. SetType Method for a Property SetThe SetType method sets the value for the type attribute of a property set. This method does not return any information. FormatTable 100 describes the arguments for the SetType method.
Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server Related TopicsFor more information, see the following topics: SetValue Method for a Property SetThe SetValue method sets the value for the value attribute of a property set. This method does not return any information. FormatTable 101 describes the arguments for the SetValue method.
Used WithBrowser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script, Web Client Automation Server Related Topics |
![]() ![]() |
Siebel Object Interfaces Reference | Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |