SetUserProperty Method for a Business Component

The SetUserProperty method sets the value of a user property in a business component. A user property is similar to an instance variable of a business component. This method does not return any information.

Format

BusComp.SetUserProperty propertyName, newValue

The following table describes the arguments for the SetUserProperty method.

Argument Description

propertyName

String that identifies the name of the user property.

newValue

String that contains the new value.

Usage

Usage for the SetUserProperty method is similar to the usage for the GetUserProperty method. For more information, see Usage for the GetUserProperty Method in GetUserProperty Method for a Business Component.

Used With

COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script

Examples

The following example is in Siebel VB:

Sub BusComp_SetFieldValue (FieldName As String)
   Select Case FieldName
      Case "Committed"
         me.SetUserProperty "Flagged", "Y"
   End Select
End Sub

The following is the equivalent example in Siebel eScript:

function BusComp_SetFieldValue (FieldName)
{
   switch (FieldName)
   {
      case "Committed":
         this.SetUserProperty("Flagged", "Y");
   }
}