名称

ChangeSynergy::apiObjectVector


描述

ChangeSynergy::apiObjectVector 包含单个对象的所有属性。 该类是完整的 apiQueryData 类,还包含子报告数据,仅当该类是报告 api 函数调用的结果时,它才为 true。“对象数量”是 apiObjectVector 实例所包含的属性数量。“转换链接数据”可以有多种形式,但是数据用于创建 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>

方法

以下方法可用:

new
 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 数据
addDataObject

将新的 apiObjectData 类添加到 apiObjectVector 所包含数据对象的当前列表中。这种方法用于添加多个属性 (apiObjectData) 元素,从而它们可用于创建定制提交表单。这种定制提交表单可用于导入变更请求到任何状态。

$objectVector->addDataObject($objectData)

 参数:
apiObjectData - 要添加到 apiObjectVector 列表中的新 apiObjectData。 
getChildData

获取子报告数据。返回结果是 apiQueryData 类的实例。

my $childData = $objectVector->getChildData()

 返回:apiQueryData
子报告数据,或如果不存在子级数据,则是未定义的
getDataObject

根据位置在对象数组中获取一个属性数据对象。 返回的结果为 apiObjectData 类的实例。

my $dataObject = $objectVector->getDataObject($iPos)

 参数:
	iPos - 用于检索数据的索引位置。
 返回:apiObjectData
对象数组中基于位置的一个属性数据对象。
 抛出:

	die - 如果列表为空。

	die - 如果指定的索引位置无效。
getDataObjectByName

根据属性名称从对象数组中获取一个属性数据对象。 返回的结果为 apiObjectData 类的实例。

my $dataobject = $objectVector->getDataObjectByName($name)

 参数:
	name - 要检索的 dataObject 的属性名称。 
 返回:apiObjectData
对象数组中基于属性名称的一个属性数据对象。
 抛出:

	die - 如果指定的值无法查找到。
getDataSize

获取该类实例所包含的属性数量。

my $dataSize = $objectVector->getDataSize()

 返回:标量
该类实例所包含的属性数量,如果未设置,则为 -1

getTransitions

获取用于创建 apiTransitions 类的字符串数据。

my $transitions = $objectVector->getTransitions()

 返回:标量
用于创建 apiTransitions 类的字符串数据。

getTransitionLink

根据位置在对象数组中获取一个转换数据对象。 返回结果是 apiTransitions 类的实例。

my $transLink = $objectVector->getTransitionLink($iPos)

 参数:
	iPos - 用于检索数据的索引位置。
 返回:apiTransitions
对象数组中基于位置的一个转换数据对象。
  抛出:

	die - 如果列表为空。

	die - 如果指定的索引位置无效。
getTransitionLinkSize

获取该类实例所包含的转换链接数量。

my $transitionLinkSize = $objectVector->getTransitionLinkSize()

 返回:标量
该类实例所包含的转换链接数量,如果未设置,则为 -1

getXmlData

获取用于构造 apiObjectVector 类的 XML 数据。

注意:仅适用于调试。

my $xmlData = $objectVector->getXmlData()

 返回:标量
用于构造此对象的 XML 数据,非常适用于调试。  
setTransitions

设置类实例的“转换字符串数据”属性。它还将根据新数据删除并重新创建 apiTransitions。字符串数据的格式应该符合 apiTransitions 类描述中声明的四种类型之一。

$objectVector->setTransitions($transitions)

 参数:
	transitions - 符合四种类型之一的新转换集。
toAttributeXml

获取用于发送至 IBM Rational Change 服务器的 XML 数据。

api 函数用于构造将提交给 IBM Rational Change 服务器的 XML 字符串。

my $xmlData = $objectVector->toAttributeXml()

 返回:标量
提交给 IBM Rational Change 服务器的 XML 数据。该函数将获取对象中的所有当前信息,并将其转换为 XML。
toObjectXml

获取用于发送至 IBM Rational Change 服务器的 XML 数据。

api 函数用于构造将提交给 IBM Rational Change 服务器的 XML 字符串。

my $xmlData = $objectVector->toObjectXml()

 返回:标量
提交给 IBM Rational Change 服务器的 XML 数据。该函数将获取对象中的所有当前信息,并将其转换为 XML。
toShowXml

获取用于发送至 IBM Rational Change 服务器的 XML 数据。

api 函数用于构造将提交给 IBM Rational Change 服务器的 XML 字符串。

my $xmlData = $objectVector->toShowXml()

 返回:标量
提交给 IBM Rational Change 服务器的 XML 数据。该函数将获取对象中的所有当前信息,并将其转换为 XML。
toSubmitXml

获取用于发送至 IBM Rational Change 服务器的 XML 数据。

api 函数用于构造将提交给 IBM Rational Change 服务器的 XML 字符串。

my $xmlData = $objectVector->toSubmitXml()

 返回:标量

提交给 IBM Rational Change 服务器的 XML 数据。该函数将获取对象中的所有当前信息,并将其转换为 XML。
toXml

获取用于发送至 IBM Rational Change 服务器的 XML 数据。

api 函数用于构造将提交给 IBM Rational Change 服务器的 XML 字符串。

my $xmlData = $objectVector->toXml()

 返回:标量
提交给 IBM Rational Change 服务器的 XML 数据。该函数将获取对象中的所有当前信息,并将其转换为 XML。