SiebPDQ Object
Description
A predefined query in a Siebel test automation environment.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SiebPDQ object.
Note: You can also view a list and descriptions of the SiebPDQ description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.
Methods
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the specified object property achieves the specified value within the specified timeout. |
ChildObjects | Returns the collection of child objects contained within the object. |
GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
GetPDQByIndex | Returns the visible title of the PDQ object. |
GetROProperty | Returns the current value of the specified description property from the object in the application. |
GetTOProperties | Returns the collection of properties and values used to identify the object. |
GetTOProperty | Returns the value of the specified description property from the test object description. |
Highlight | Highlights the object in the application. |
IsExists | Indicates whether the specified object exists. |
Output | Retrieves the current value of an item and stores it in a specified location. |
RefreshObject | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
Select | Selects a PDQ. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the current test object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
ActivePDQ | A data value representing the visible query title. |
ClassName | The class of the object. |
Count | The number of objects of a given type that are present in the current context. |
Exist | Checks whether the object currently exists in the open application. |
RepositoryName | The name of the object as it is stored in the repository. |
UIName | The name of the object as it is appears in the user interface. |
GetPDQByIndex Method
Description
Returns the visible title of the PDQ object.
Syntax
object.GetPDQByIndex (Index)
Arguments
Parameter | Description |
---|---|
Index |
Required. A long integer value. The index of the PDQ object within the Count property. |
Return Type
A String value.
Example
'The following example uses the GetPDQByIndex method to enumerate through 'items inside the "PDQ" predefined query, select each item in turn and 'verify the results by comparing the expected and active queries. var_ClassName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ClassName var_UIName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").UIName var_RepositoryName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").RepositoryName var_ObjectSring = "Object of class " & var_ClassName & " with UI name " & var_UIName & " and RepositoryName " & var_RepositoryName var_count = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Count For i = 0 To var_count - 1 var_NextQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").GetPDQByIndex(i) SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Select (var_NextQuery) var_ActiveQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ActivePDQ If var_NextQuery = var_ActiveQuery Then Reporter.ReportEvent 0, var_ObjectSring, "behaves as expected for query : " & var_NextQuery & " on position " & i Else Reporter.ReportEvent 1, var_ObjectSring, "does not behave properly for query: " & var_NextQuery & " on position " & i End If Next
IsExists Method
Description
Indicates whether the specified object exists.
Syntax
object.IsExists (ItemName)
Arguments
Parameter | Description |
---|---|
ItemName |
Required. A String value. The visible title of the PDQ or Picklist object. |
Return Type
A long integer value.
Example
'The following example checks whether the "No Contacts" item exists in the PDQ. 'If so, it selects it. If SiebApplication("Siebel Call Center").SiebScreen("Contacts").SiebPDQ("PDQ").IsExists("No Contacts") Then SiebApplication("Siebel Call Center").SiebScreen("Contacts").SiebPDQ("PDQ").Select "No Contacts" End If
Select Method
Description
Selects a PDQ.
Syntax
object.Select (ItemName)
Arguments
Parameter | Description |
---|---|
ItemName |
Required. A String value. The visible title of the PDQ. |
Return Type
None.
Example
'The following example uses the Select method to select each item in the '"PDQ" predefined query and verify the results by comparing the expected 'and active queries. var_ClassName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ClassName var_UIName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").UIName var_RepositoryName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").RepositoryName var_ObjectSring = "Object of class " & var_ClassName & " with UI name " & var_UIName & " and RepositoryName " & var_RepositoryName var_count = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Count For i = 0 To var_count - 1 var_NextQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").GetPDQByIndex(i) SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Select (var_NextQuery) var_ActiveQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ActivePDQ If var_NextQuery = var_ActiveQuery Then Reporter.ReportEvent 0, var_ObjectSring, "behaves as expected for query : " & var_NextQuery & " on position " & i Else Reporter.ReportEvent 1, var_ObjectSring, "does not behave properly for query: " & var_NextQuery & " on position " & i End If Next
ActivePDQ Property
Description
A data value representing the visible query title.
Syntax
object.ActivePDQ
Value Type
A String value.
Property type
Read-only property
Example
'The following example uses the ActivePDQ property to verify query results by 'comparing the expected and active queries for each item in the "PDQ" 'predefined query. var_ClassName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ClassName var_UIName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").UIName var_RepositoryName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").RepositoryName var_ObjectSring = "Object of class " & var_ClassName & " with UI name " & var_UIName & " and RepositoryName " & var_RepositoryName var_count = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Count For i = 0 To var_count - 1 var_NextQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").GetPDQByIndex(i) SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Select (var_NextQuery) var_ActiveQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ActivePDQ If var_NextQuery = var_ActiveQuery Then Reporter.ReportEvent 0, var_ObjectSring, "behaves as expected for query : " & var_NextQuery & " on position " & i Else Reporter.ReportEvent 1, var_ObjectSring, "does not behave properly for query: " & var_NextQuery & " on position " & i End If Next
ClassName Property
Description
The class of the object.
Syntax
object.ClassName
Value Type
A String value.
Property type
Read-only property
Example
'The following example uses the UIName and ClassName properties to display this 'information for all child objects of the Siebel Call Center application. 'Retrieve all the children of the siebel application object Set MyDescription = Description.Create() Set MyChildren = SiebApplication("Siebel Call Center").ChildObjects(MyDescription) childCount = MyChildren.Count 'Display the UI names and classes for each object. For i = 0 To childCount - 1 MsgBox MyChildren(i).UIName + " object of class " + MyChildren(i).ClassName Next
Count Property
Description
The number of objects of a given type that are present in the current context.
Syntax
object.Count
Value Type
A long integer value.
Property type
Read-only property
Example
'The following example uses the Count property to find the total number of 'items in the "PDQ" predefined query, select each item in turn and verify 'the results by comparing the expected and active queries. var_ClassName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ClassName var_UIName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").UIName var_RepositoryName = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").RepositoryName var_ObjectSring = "Object of class " & var_ClassName & " with UI name " & var_UIName & " and RepositoryName " & var_RepositoryName var_count = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Count For i = 0 To var_count - 1 var_NextQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").GetPDQByIndex(i) SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").Select (var_NextQuery) var_ActiveQuery = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebPDQ("PDQ").ActivePDQ If var_NextQuery = var_ActiveQuery Then Reporter.ReportEvent 0, var_ObjectSring, "behaves as expected for query : " & var_NextQuery & " on position " & i Else Reporter.ReportEvent 1, var_ObjectSring, "does not behave properly for query: " & var_NextQuery & " on position " & i End If Next
RepositoryName Property
Description
The name of the object as it is stored in the repository.
Syntax
object.RepositoryName
Value Type
A String value.
Property type
Read-only property
UIName Property
Description
The name of the object as it is appears in the user interface.
Syntax
object.UIName
Value Type
A String value.
Property type
Read-only property
Example
'The following example finds all the objects in the Daily Calendar with the same 'classname as a specified SiebPickList object and then displays the Repository 'name of each of these objects. Set MyDescription = Description.Create() MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription) childCount = MyChildren.Count ' now we show test object names For i = 0 To childCount - 1 MsgBox MyChildren(i).RepositoryName Next
See also:
- SblAdvancedEdit
- SblButton
- SblCheckBox
- SblEdit
- SblPickList
- SblTable
- SblTabStrip
- SblTreeView
- SiebApplet
- SiebApplication
- SiebButton
- SiebCalculator
- SiebCalendar
- SiebCheckbox
- SiebCommunicationsToolbar
- SiebCurrency
- SiebInkData
- SiebList
- SiebMenu
- SiebPageTabs
- SiebPDQ
- SiebPicklist
- SiebRichText
- SiebScreen
- SiebScreenViews
- SiebTask
- SiebTaskAssistant
- SiebTaskLink
- SiebTaskStep
- SiebTaskUIPane
- SiebText
- SiebTextArea
- SiebThreadbar
- SiebToolbar
- SiebTree
- SiebView
- SiebViewApplets