ChangeSynergy::apiObjectVector
ChangeSynergy::apiObjectVector は 1 つのオブジェクトのすべての属性を保持します。 このクラスは、完全な apiQueryData クラスであるサブレポート・データも保持します (ただし、 レポート API の関数呼び出しの結果がクラスである場合にのみ該当します)。「オブジェクト数」(number of objects) は、この apiObjectVector インスタンスが保持する属性の数です。 「遷移リンク・データ」(transition link data) は各種のフォームをとることができますが、このデータは apiTransitions クラスのインスタンスの作成に使用されます。
<csapi_cobject_vector_position> or <csapi_cobject_vector> <csapi_cobject_data_size>number of objects</csapi_cobject_data_size> <csapi_cobject_vector_transitions>transition link data</csapi_cobject_vector_transitions>
<csapi_cobject_vector_assoc> <csapi_cquery_data> . . . </csapi_cquery_data> </csapi_cobject_vector_assoc>
<csapi_cobject_data> <csapi_cobject_data_name>attribute name</csapi_cobject_data_name> <csapi_cobject_data_value>attribute value</csapi_cobject_data_value> <csapi_cobject_data_type>web type</csapi_cobject_data_type> <csapi_cobject_data_readonly>true|false</csapi_cobject_data_readonly> <csapi_cobject_data_required>true|false</csapi_cobject_data_required> <csapi_cobject_data_inherited>true|false</csapi_cobject_data_inherited> <csapi_cobject_data_default>default value for this attribute</csapi_cobject_data_default> <csapi_cobject_data_date>formatted date</csapi_cobject_data_date> </csapi_cobject_data> . . .
</csapi_cobject_vector> or </csapi_cobject_vector_position>
以下のメソッドを使用できます。
sub new(xmlData) sub new(xmlData, parent);
新しく作成される ChangeSynergy::apiObjectVector クラスを初期化して、渡される XML データを表すようにします。
オブジェクト・データを表示するために使用されます。 my $objectVector = new ChangeSynergy::apiObjectVector(xmlData);
レポート API のみが使用します。 my $objectVector = new ChangeSynergy::apiObjectVector(xmlData, parent); パラメーター: xmlData - 構文解析して使用可能なフォームへ変換する必要がある XML データ。 parent - この apiObjectVector の親。
スロー: die - XML データの構文解析ができない場合。
新しい apiObjectData クラスを、この apiObjectVector が保持するデータ・オブジェクトの現在のリストに追加します。このメソッドを使用して複数の属性 (apiObjectData) 要素を追加すれば、これらの要素を使用してカスタムの提出フォームを作成できます。 次に、このカスタムの提出フォームを使用して、どの状態への変更依頼でもインポートできます。
$objectVector->addDataObject($objectData)
パラメーター: apiObjectData - apiObjectVector のリストに追加される新しい apiObjectData。
サブレポート・データを取得します。 返される結果は apiQueryData クラスのインスタンスです。
my $childData = $objectVector->getChildData()
戻り値: apiQueryData サブレポート・データ、または子データがない場合は undef。
オブジェクト配列内の位置に基づいて、属性データ・オブジェクトを 1 つ取得します。 返される結果は apiObjectData クラスのインスタンスです。
my $dataObject = $objectVector->getDataObject($iPos)
パラメーター: iPos - データ読み出しのためのインデックス位置。
戻り値: apiObjectData オブジェクト配列内の位置に基づく 1 つの属性データ・オブジェクト。
スロー: die - リストが空の場合。 die - 指定したインデックス位置が無効の場合。
オブジェクト配列からの属性名に基づいて、属性データ・オブジェクトを 1 つ取得します。 返される結果は apiObjectData クラスのインスタンスです。
my $dataobject = $objectVector->getDataObjectByName($name)
パラメーター: name - 取得する dataObject の属性名。
戻り値: apiObjectData オブジェクト配列からの属性名に基づく 1 つの属性データ・オブジェクト。
スロー: die - 指定した値が見つからなかった場合。
このクラス・インスタンスが保持する属性の数を取得します。
my $dataSize = $objectVector->getDataSize()
戻り値: スカラー このクラス・インスタンスが保持する属性の数。設定されていない場合は (-1)。
apiTransitions クラスを作成するために使用される文字列データを取得します。
my $transitions = $objectVector->getTransitions()
戻り値: スカラー apiTransitions クラスを作成するために使用される文字列データ。
オブジェクト配列内の位置に基づいて、遷移データ・オブジェクトを 1 つ取得します。 返される結果は apiTransitions クラスのインスタンスです。
my $transLink = $objectVector->getTransitionLink($iPos)
パラメーター: iPos - データ読み出しのためのインデックス位置。
戻り値: apiTransitions オブジェクト配列内の位置に基づく 1 つの遷移データ・オブジェクト。
スロー: die - リストが空の場合。 die - 指定したインデックス位置が無効の場合。
このクラス・インスタンスが保持する遷移リンクの数を取得します。
my $transitionLinkSize = $objectVector->getTransitionLinkSize()
戻り値: スカラー このクラス・インスタンスが保持する遷移リンクの数。設定されていない場合は (-1)。
この apiObjectVector クラスの作成に使用される XML データを取得します。
注記: これはデバッグ専用です。
my $xmlData = $objectVector->getXmlData()
戻り値: スカラー このオブジェクトの作成に使用される XML データ。デバッグに役立ちます。
このクラス・インスタンスの「遷移文字列データ」(transition string data) プロパティーを設定します。このメソッドは、新しいデータに基づいて apiTransitions の削除と再生を実行します。文字列データのフォーマットは、apiTransitions クラスの説明で述べた 4 つのタイプの 1 つに一致している必要があります。
$objectVector->setTransitions($transitions)
パラメーター: transitions - 4 つのタイプの 1 つに一致する新しい遷移のセット。
IBM Rational Change サーバーへの提出に使用される XML データを取得します。
IBM Rational Change サーバーに提出される XML 文字列を構築する API 関数によって使用されます。
my $xmlData = $objectVector->toAttributeXml()
戻り値: スカラー IBM Rational Change サーバーへの送出のために使われる XML データ。 この関数はオブジェクト内の現在の情報をすべて取り出し、それらを XML に変換します。
IBM Rational Change サーバーへの提出に使用される XML データを取得します。
IBM Rational Change サーバーに提出される XML 文字列を構築する API 関数によって使用されます。
my $xmlData = $objectVector->toObjectXml()
戻り値: スカラー IBM Rational Change サーバーへの送出のために使われる XML データ。 この関数はオブジェクト内の現在の情報をすべて取り出し、それらを XML に変換します。
IBM Rational Change サーバーへの提出に使用される XML データを取得します。
IBM Rational Change サーバーに提出される XML 文字列を構築する API 関数によって使用されます。
my $xmlData = $objectVector->toShowXml()
戻り値: スカラー IBM Rational Change サーバーへの送出のために使われる XML データ。 この関数はオブジェクト内の現在の情報をすべて取り出し、それらを XML に変換します。
IBM Rational Change サーバーへの提出に使用される XML データを取得します。
IBM Rational Change サーバーに提出される XML 文字列を構築する API 関数によって使用されます。
my $xmlData = $objectVector->toSubmitXml()
戻り値: スカラー IBM Rational Change サーバーへの送出のために使われる XML データ。 この関数はオブジェクト内の現在の情報をすべて取り出し、それらを XML に変換します。
IBM Rational Change サーバーへの提出に使用される XML データを取得します。
IBM Rational Change サーバーに提出される XML 文字列を構築する API 関数によって使用されます。
my $xmlData = $objectVector->toXml()
戻り値: スカラー IBM Rational Change サーバーへの送出のために使われる XML データ。 この関数はオブジェクト内の現在の情報をすべて取り出し、それらを XML に変換します。