名前

ChangeSynergy::apiListObject


詳細

ChangeSynergy::apiListObject とそれに関連付けられている API の呼び出しは、IBM Rational Change 構成データからリスト・タイプのデータを取得するために使用します。 取得できるデータは valuelistbox、listbox、list、datalistbox、report および query です。

 *************************************
 *データ・タイプ別の 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>

メソッド

以下のメソッドを使用できます。

new
 sub new(xmlData, dataType)

新しく作成される ChangeSynergy::apiListObject クラスを初期化して、渡される XML データを表すようにします。

 my $listobject = new ChangeSynergy::apiListObject(xmlData, dataType);
 
パラメーター:
	xmlData  - 構文解析して使用可能なフォームへ変換する必要がある XML データ。
	dataType - 構文解析される XML データのタイプ。
	使用できる dataType は globals.pm ファイルで定義され、以下があります。
	  VALUELISTBOX_TYPE
	  LISTBOX_TYPE
	  LIST_TYPE
	  DATALISTBOX_TYPE
	  REPORT_TYPE
	  QUERY_TYPE
 スロー:

die - XML データの構文解析ができない場合。
getDateLastRun

レポートまたはクエリーが実行された最後の日付を取得します。

my $dateLastRun = $listobject->getDateLastRun()

 戻り値: スカラー
 	このリストのレポートに対して最後に実行されたレポート/クエリーの日付。
getExportForm

レポートのエクスポート・フォーマットを取得します。

my $exportForm = $listobject->getExportForm()

 戻り値: スカラー
 	このリストのレポートのレポート・エクスポート・フォーマット。
getLabel

指定した位置の Label リストを取得します。

my $label = $listobject->getLabel($iPos)

 パラメーター: 
iPos - データ読み出しのためのインデックス位置。
 戻り値: スカラー
 	指定した位置の Label リスト。
 スロー:

die - リストが空の場合。
die - 指定したインデックス位置が無効の場合。
getListboxSize

リスト・ボックスのサイズを取得します。

my $listboxSize = $listobject->getListboxSize()

 戻り値: スカラー
 	要求されたリスト・ボックスのサイズ。
getListSection

リストのセクション ID を取得します。

my $listSelection = $listobject->getListSection()

 戻り値: スカラー
 	リストのセクション ID。可能な値は globals.pm ファイルで定義されます。
	QUERY_SECTION
	REPORT_SECTION
	LISTBOX_SECTION
	LIST_SECTION
	VALUELISTBOX_SECTION
getListSize

リストのサイズを取得します。

my $listSize = $listobject->getListSize()

 戻り値: スカラー
 	要求されたリストのサイズ。
getName

レポートまたはクエリーの名前を取得します。

my $name = $listobject->getName()

 戻り値: スカラー
 	このリストのレポートのレポート/クエリーの名前。
getQueryName

レポートまたはクエリーのクエリー名を取得します。

my $queryName = $listobject->getQueryName()

 戻り値: スカラー
 	このリストのレポートのレポート/クエリーのクエリー名。
getQueryString

レポートまたはクエリーによって使用されるクエリー文字列を取得します。

my $queryString = $listobject->getQueryString()

 戻り値: スカラー
 	このリストのレポートのレポート/クエリーのクエリー文字列。
getSubreportName

指定した位置の Subreport Name リストを取得します。

my $subreportName = $listobject->getSubreportName($iPos)

 パラメーター:
iPos - データ読み出しのためのインデックス位置。
 戻り値: スカラー
 	指定した位置の Subreport Name リスト。
 スロー:

	die - レポート・エントリー・リストが空の場合。

die - 指定したインデックス位置が無効の場合。
getSubreportRelation

指定した位置の Subreport Relation リストを取得します。

my $subreportRelation = $listobject->getSubreportRelation($iPos)

 パラメーター:
iPos - データ読み出しのためのインデックス位置。
 戻り値: スカラー
 	指定した位置の Subreport Relation リスト。
 スロー:

	die - レポート・エントリー・リストが空の場合。

die - 指定したインデックス位置が無効の場合。
getSubreportSize

レポート構造体のサイズを取得します。

my $subReportSize = $listobject->getSubreportSize()

 戻り値: スカラー
 	レポート構造体のサイズ。
getSubreportType

指定した位置の Subreport Type リストを取得します。

my $subreportType = $listobject->getSubreportType($iPos)

 パラメーター:
iPos - データ読み出しのためのインデックス位置。
 戻り値: スカラー
 指定した位置の Subreport Type リスト。可能な値は globals.pm ファイルで定義されます。
	PROBLEM_REPORT
	TASK_REPORT
	OBJECT_REPORT
getValue

指定した位置の Value リストを取得します。

my $value = $listobject->getValue($iPos)

 パラメーター:
iPos - データ読み出しのためのインデックス位置。
 戻り値: スカラー
 	指定した位置の Value リスト。
 スロー:

die - リストが空の場合。
die - 指定したインデックス位置が無効の場合。
getValueListboxSize

Valuelistbox のサイズを取得します。

my $valueListSize = $listobject->getValueListboxSize()

 戻り値: スカラー
 	要求された Valuelistbox のサイズ。
getXmlData

このオブジェクトの作成に使用される XML データを返します。

注記: これはデバッグ専用です。

my $xmlData = $listobject->getXmlData()

 戻り値: スカラー
 このオブジェクトの作成に使用される XML データ。デバッグに役立ちます。