Bookshelf Home | Contents | Index | PDF |
Siebel Object Interfaces Reference > Siebel Object Interfaces Reference > Object Interfaces Reference > Business Service MethodsThis topic describes business service methods. It includes the following topics:
In this topic, the oService variable identifies a business service instance. GetFirstProperty Method for a Business ServiceThe GetFirstProperty method returns a string that contains the name of the first property that is defined for a business service. FormatUsage for a Method that Gets a Business Service PropertyThe order that Siebel CRM uses to store properties in a property set is random. For example, the Name property is the first property that Siebel Tools displays in the Business Services list for every business service. However, the GetFirstProperty method might return any business service property, not necessarily the Name property. To correct this situation it is recommended that you add the properties in a property set to an array, and then sort that array. To get or modify a property value, you can do the following:
For more information, see the following topics:
Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script Example of Using Methods that Return a Business Service PropertyThe example in this topic returns the number of property sets that belong to a business service. The following example is in Siebel eScript: function countPropSets(busService) while(propSetName != "") The following example is for Siebel Java Data Bean: public int countPropSets(SiebelService busService) catch(SiebelException sExcept) GetNextProperty Method for a Business ServiceThe GetNextProperty method returns a string that contains the name of the next property of a business service. If no more properties exist, then this method returns an empty string. FormatUsage for the GetNextProperty MethodAfter you call the GetFirstProperty method to return the name of the first property of a business service, you can call the GetNextProperty to return the name of the next property. This next property is the next property that is defined for a business service after the first property. You can use the GetNextProperty consecutively to cycle through all the properties of a business service until no more properties exist, at which point Siebel CRM returns an empty string. Usage for the GetNextProperty is similar to usage for the GetFirstProperty method. For more information, see Usage for a Method that Gets a Business Service Property. Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script ExamplesFor examples, see Example of Using Methods that Return a Business Service Property. GetProperty Method for a Business ServiceThe GetProperty method returns a string that contains the value of a property. If the property does not exist, then this method returns NULL. FormatoService.GetProperty(propName) Table 83 describes the arguments for the GetProperty method.
UsageTo return the value for this property you must know the name of the property. To return a property name, use the GetFirstProperty method or the GetNextProperty method. For more information, see Usage for a Method that Gets a Business Service Property. Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script InvokeMethod Method for a Business ServiceThe InvokeMethod method calls a method on a business service. This method can be a specialized method or a custom method. For more information, see About Specialized and Custom Methods. This method does not return any information. Siebel eScript FormatoService.InvokeMethod(methodName, InputArguments, OutputArguments) Table 84 describes the arguments for the Siebel eScript format of the InvokeMethod method. Siebel VB FormatoService.InvokeMethod methodName, InputArguments, OutputArguments The arguments you use in this format are the same as the arguments that are described in Table 84. Browser Script FormatoutputPropSet=Service.InvokeMethod(MethodName, inputPropSet) The arguments you use with this format are the same as the arguments described in Table 25. In Browser Script, you cannot use an output property set for this format. UsageA predefined business service works in a way that is similar to how a call to a business component method works. You can call a specialized method on a business service that is not available directly through the object interface. You must use this method only with Siebel VB or Siebel eScript scripts. You must use Siebel Tools to write these scripts. You can call these scripts from an external interface. A run-time business service can include a custom method. Although the InvokeMethod function does not return a value, the properties in the OutputArguments property set might be modified. For more information, see Caution About Using the InvokeMethod 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: Name Method for a Business ServiceThe Name method returns a string that contains the name of a business service. FormatUsed 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 is in Browser Script: var svc = theApplication().GetService("Data Quality Manager"): PropertyExists Method for a Business ServiceThe PropertyExists method returns one of the following values to indicate if a property exists:
FormatoService.PropertyExists(propName) Table 85 describes the arguments for the PropertyExists method. UsageUse the PropertyExists method in an If statement to determine if a specific property is set. Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script Release Method for a Business ServiceThe Release method for a business service releases a business service and the resources that this business service uses on the Siebel Server. FormatUsed WithExamplesThe following example logs in to a Siebel Server. It then creates a business object instance, a business component instance, and a business service instance. Next, it releases them in reverse order. import com.siebel.data.*; public class JDBReleaseDemo public static void main(String[] args) public JDBReleaseDemo() // instantiate the Siebel Java Data Bean // login to the Siebel Servers // get the business object // get the business component // get the business service //release the business service //release the business component System.out.println("BC released "); //release the business object // logoff catch (SiebelException e) RemoveProperty Method for a Business ServiceThe RemoveProperty method removes a property from a business service. This method does not return any information. FormatoService.RemoveProperty(propName) Table 86 describes the arguments for the RemoveProperty method.
UsageThis method removes the property that the propName argument identifies from the business service that the oService parameter specifies. As a result, a subsequent call to the PropertyExists method for that property returns FALSE. For more information, see PropertyExists Method for a Business Service. Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script SetProperty Method for a Business ServiceThe SetProperty method sets a value in the property of a business service. This method does not return any information. FormatoService.SetProperty(propName, propValue) Table 87 describes the arguments for the SetProperty method. UsageYou can use the SetProperty method to set the value of a property of a business service from one of the methods of this business service or from an external object. For more information, see GetProperty Method for a Business Service. Used WithBrowser Script, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script ExamplesFor an example, see Service_PreInvokeMethod Event. |
Siebel Object Interfaces Reference | Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |