名前

ChangeSynergy::apiSubscription


詳細

登録者リストにより、ユーザーは自分自身が CR の登録者であることを示すことができます。 ユーザーは CR への登録を依頼するとき、CR の変更時には通知してほしいと考えます。このクラスにより、この API は特定のリストに登録されたユーザーを取得して修正できます。このクラスのインスタンスの作成に使用される XML フォーマットは次のとおりです。

 <subscription>
	<subscriber>
		<username>
			user name
		</username>
		<email>
			user email
		</email>
		<realname>
			real name
		</realname>
	</subscriber>
	.
	.
	.
 </subscription>

メソッド

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

new
 sub new(xmlData)

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

 my $subscription = new ChangeSynergy::apiSubscription(xmlData);
 
パラメーター:
xmlData  - 構文解析して使用可能なフォームへ変換する必要がある XML データ。
 スロー:

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

新規登録者を登録者リストに追加します。すべてのパラメーターが必須です。

注記: これによって直ちに登録者がリストに追加されるわけではありません。登録者を追加するためには、CR を新しい XML 情報で更新する必要があります。 getSubscription() メソッドの apiObjectData クラスの例を参照してください。

$subscription->addSubscriber("jsmith", "John Smith", "John.Smith@company.com");

 パラメーター:
	userName - 登録者リストに追加するユーザーのユーザー名。
	realName - 登録者リストに追加するユーザーの実名。
	eMail    - 登録者リストに追加するユーザーの E メール・アドレス。
 スロー:
 	die - 指定したユーザー名が、リスト内の別ユーザーに使用されている場合。
getSubscriber

オブジェクト配列内の位置に基づいて、登録者データ・オブジェクトを 1 つ取得します。 返される結果は apiSubscriber クラスのインスタンスです。

my $subscriber = $subscription->getSubscriber($iPos);

 パラメーター:
iPos - データ読み出しのためのインデックス位置。
 戻り値: apiSubscriber
	1 つの登録者オブジェクト。
getSubscriberByEmailAddress

登録者の E メール・アドレスに基づいて、登録者データ・オブジェクトを取得します。 返される結果は apiSubscriber クラスのインスタンスです。

注記: アットマーク("@") をエスケープするためには、円記号("\") を使用します。

my $subscriber = $subscription->getSubscriberByEmailAddress("John.Smith\@company.com");

 パラメーター:
	email - 読み出すユーザー・オブジェクトの E メール・アドレス。
 戻り値: apiSubscriber
	1 つの登録者オブジェクト。
	
スロー:
	die - ユーザーの E メール・アドレスが登録者リストに存在しない場合。
getSubscriberByRealName

登録者の実名に基づいて、登録者データ・オブジェクトを取得します。 返される結果は apiSubscriber クラスのインスタンスです。

my $subscriber = $subscription->getSubscriberByRealName("John Smith");

 パラメーター:
	realName - 読み出すユーザー・オブジェクトの実名。
 戻り値: apiSubscriber
	1 つの登録者オブジェクト。
	
スロー:
	die - ユーザーの実名が登録者リストに存在しない場合。
getSubscriberByUserName

登録者のユーザー名に基づいて、登録者データ・オブジェクトを取得します。 返される結果は apiSubscriber クラスのインスタンスです。

my $subscriber = $subscription->getSubscriberByUserName("u00001");

 パラメーター:
	username - 読み出すユーザー・オブジェクトのユーザー名。
 戻り値: apiSubscriber
	1 つの登録者オブジェクト。
	
スロー:
	die - ユーザー名が登録者リストに存在しない場合。
getSubscriberSize

登録者オブジェクト数を取得します。

my $subSize = $subscription->getSubscriberSize();

 戻り値: スカラー
 	この登録での登録者オブジェクト数。
getXmlData

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

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

my $xmlData = $subscription->getXmlData();

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

登録者リストを更新するために IBM Rational Change サーバーに送られる XML データを取得します。

my $xmlData = $subscription->toSubmitXml();

 戻り値: スカラー
 	IBM Rational Change サーバーに送出される XML データ。