ChangeSynergy::apiListObject
ChangeSynergy::apiListObject 及其相关 api 调用用于从 IBM Rational Change 配置数据中获取列表类型数据。可以获取的数据包括:值列表框、列表框、列表、数据列表框、报告和查询。
************************************* * 适用于数据类型的 XML 格式 * *************************************
GetDatabases api call:
<csapi_listbox_value> Database name. </csapi_listbox_value> <csapi_listbox_label> Database alias. </csapi_listbox_label> . . .
GetHosts api call:
<csapi_listbox_value> Host name. </csapi_listbox_value> <csapi_listbox_label> Host type. [UNIX|NT] </csapi_listbox_label> . . .
Valuelistbox:
<csapi_listbox_value> Valuelistbox value. </csapi_listbox_value> <csapi_listbox_label> Valuelistbox label. </csapi_listbox_label> . . .
Listbox:
<csapi_listbox_value> Listbox position. </csapi_listbox_value> <csapi_listbox_label> Listbox value. </csapi_listbox_label> . . .
List:
<csapi_section> List item type. [CCM_QUERY|CCM_REPORT|CCM_LISTBOX|CCM_LIST|CCM_VALUELISTBOX] </csapi_section> <csapi_listbox_value> List item position. </csapi_listbox_value> <csapi_listbox_label> List item name. </csapi_listbox_label> . . .
Datalistbox:
返回基于角色的列表引用,或缺省列表 (如果未指定角色列表)。
<csapi_section> List item type. [CCM_QUERY|CCM_REPORT|CCM_LISTBOX|CCM_LIST|CCM_VALUELISTBOX] </csapi_section> <csapi_listbox_value> List item position. </csapi_listbox_value> <csapi_listbox_label> List item name. </csapi_listbox_label> . . .
Report:
<csapi_name> Report name. </csapi_name> <csapi_export_form> Report export format. </csapi_export_form> <csapi_qry_name> Report query name. </csapi_qry_name> <csapi_qry_string> Report query string. </csapi_qry_string> <csapi_date_last_run> Report date query was last run. </csapi_date_last_run> <csapi_subreports> <csapi_subreport> <csapi_subreport_name> Subreport name or top report name, if it is the top report. </csapi_subreport_name> <csapi_relation_name> Report Relation name, or blank if it is the top report. </csapi_relation_name> <csapi_relation_type> Report type. [PROBLEM_TYPE|TASK_TYPE|OBJECT_TYPE] </csapi_relation_type> </csapi_subreport> . . . </csapi_subreports>
Query:
<csapi_name> Query name. </csapi_name> <csapi_qry_string> Query string. </csapi_qry_string> <csapi_date_last_run> Date query was last run. </csapi_date_last_run>
以下方法可用:
sub new(xmlData, dataType)
初始化新创建的 ChangeSynergy::apiListObject 类,以便使其表示传入的 xml 数据。
my $listobject = new ChangeSynergy::apiListObject(xmlData, dataType); 参数: xmlData - 需要解析成可用格式的 XML 数据。 dataType - 要解析的 XML 数据的类型
可用的数据类型定义在 globals.pm 文件中,分别为: VALUELISTBOX_TYPE LISTBOX_TYPE LIST_TYPE DATALISTBOX_TYPE REPORT_TYPE QUERY_TYPE
抛出: die - 如果不能解析 xml 数据
获取报告或查询最后一次运行的日期。
my $dateLastRun = $listobject->getDateLastRun()
返回:标量 本列表中报告最后一次运行的报告/查询日期。
获取报告导出格式。
my $exportForm = $listobject->getExportForm()
返回:标量 本列表中报告的报告导出格式。
获取指定位置的列表标签。
my $label = $listobject->getLabel($iPos)
参数: iPos - 用于检索数据的索引位置。
返回:标量 指定位置的列表标签
抛出: die - 如果列表为空。 die - 如果指定的索引位置无效。
获取列表框的大小。
my $listboxSize = $listobject->getListboxSize()
返回:标量 请求的列表框的大小
获取列表的节标识。
my $listSelection = $listobject->getListSection()
返回:标量 列表的节标识,可能的值在 globals.pm 文件中定义:
QUERY_SECTION REPORT_SECTION LISTBOX_SECTION LIST_SECTION VALUELISTBOX_SECTION
获取列表的大小。
my $listSize = $listobject->getListSize()
返回:标量 请求的列表的大小
获取报告或查询的名称。
my $name = $listobject->getName()
返回:标量 本列表中报告的报告/查询名称。
获取报告或查询的查询名称。
my $queryName = $listobject->getQueryName()
返回:标量 本列表中报告的“报告/查询”查询名称。
获取报告或查询所用的查询字符串。
my $queryString = $listobject->getQueryString()
返回:标量 本列表中报告的“报告/查询”查询字符串。
获取指定位置的列表子报告名称。
my $subreportName = $listobject->getSubreportName($iPos)
参数: iPos - 用于检索数据的索引位置。
返回:标量 指定位置的列表子报告名称。
抛出: die - 如果报告项列表为空。 die - 如果指定的索引位置无效。
获取指定位置的列表子报告关系。
my $subreportRelation = $listobject->getSubreportRelation($iPos)
参数: iPos - 用于检索数据的索引位置。
返回:标量 指定位置的列表子报告关系。
抛出: die - 如果报告项列表为空。 die - 如果指定的索引位置无效。
获取报告结构的大小。
my $subReportSize = $listobject->getSubreportSize()
返回:标量 报告结构的大小
获取指定位置的列表子报告类型
my $subreportType = $listobject->getSubreportType($iPos)
参数: iPos - 用于检索数据的索引位置。
返回:标量 指定位置的列表子报告类型,可能的值在 globals.pm 文件中定义:
PROBLEM_REPORT TASK_REPORT OBJECT_REPORT
获取指定位置的列表值。
my $value = $listobject->getValue($iPos)
参数: iPos - 用于检索数据的索引位置。
返回:标量 指定位置的列表值
抛出: die - 如果列表为空。 die - 如果指定的索引位置无效。
获取值列表框的大小。
my $valueListSize = $listobject->getValueListboxSize()
返回:标量 请求的值列表框的大小
返回构造此对象所用的 XML 数据。
注意:仅适用于调试。
my $xmlData = $listobject->getXmlData()
返回:标量 用于构造此对象的 XML 数据,非常适用于调试。