名前

ChangeSynergy::TriggerParser


詳細

ChangeSynergy::TriggerParser は、IBM Rational Change の入力トリガー・ファイル用の XML パーサーです。 トリガーが起動されると、IBM Rational Change は、そのトリガーを起動したサーバーとオブジェクトに関する情報を使用して XML ファイルを生成します。 このクラスは、サーバーのプロトコル、ホスト名、ポートのほかに変更されたすべての属性のリストなどの、XML ファイルからの情報を容易に取り出せるようにします。


メソッド

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

new

sub new(xmlFile)

新しく作成される ChangeSynergy::TriggerParser クラスを初期化し、受け取る XML データをアクセス可能なデータ構造で表すようにします。

my $trigger = new ChangeSynergy::TriggerParser( 'file.xml' );

 パラメーター:
xmlFile - 構文解析されるトリガー用 XML ファイル。または構文解析を必要とする XML データを格納しているスカラー。
get_admin_token

管理者権限 (admin) のトークンを取得します。

my $token = $trigger->get_admin_token()

 戻り値: スカラー
 	admin ユーザーのトークン。
	または、トリガーで admin トークンが与えられなかった場合は undef。
get_admin_user

admin ユーザーの名前を取得します。

my $user = $trigger->get_admin_user()

 戻り値: スカラー
 	admin ユーザーのユーザー名。
	または、トリガーで admin ユーザー名を与えられなかった場合は undef。
get_attributes

XML データ内に含まれていたすべての属性を収集してハッシュに格納します。 これらの属性はトリガーが起動されたときに変更された属性 (attrs) です。

my %trigger_attributes = $trigger->get_attributes()

 戻り値: ハッシュ
	このアクション時に設定または修正されたすべてのトリガー属性。
	または xml ファイルでトリガー属性が定義されていない場合は undef。
get_database

トリガー起動時にユーザーが接続された IBM Rational Synergy データベースを取得します。 これは、IBM Rational Change サーバーへの新しい接続を作成するときに役に立ちます。

my $database = $trigger->get_database()

 戻り値: スカラー
 	トリガー起動時にユーザーが接続されたデータベース。
	または、データベースが与えられなかった場合は undef。
get_database_uid

トリガー起動時にユーザーが接続された IBM Rational Synergy データベースの uid を取得します。 これは IBM Rational Change のデータベースの一意の ID です。

my $database = $trigger->get_database_uid()

 戻り値: スカラー
 	トリガー起動時にユーザーが接続されたデータベースの uid。
	または、データベース uid が与えられなかった場合は undef。
get_dcm_delimiter

pt.cfg ファイルに定義されている E メール・アドレスを取得します。pt.cfg ファイルはトリガーによって E メールを送出するときに使用されます。

my $dcm_delimiter = $trigger->get_dcm_delimiter()

 戻り値: スカラー
 	トリガー起動時にユーザーが接続されたデータベースの DCM 区切り文字。
	または、DCM 区切り文字が与えられなかった場合は undef。
get_from_email_addr

トリガーから E メールを送信するときに使用する、pt.cfg ファイルに定義されている E メール・アドレスを取得します。

my $from_email = $trigger->get_from_email_addr();

 戻り値: スカラー
 PERL スクリプトで送信される E メールの from 部分で使用される E メール・アドレス、または undef (トリガーで from オブジェクトが指定されていない場合)。
get_from_object

遷移の実行時に、遷移元の状態は、遷移前のオブジェクトの状態になります。

my $from_object = $trigger->get_from_object()

 戻り値: スカラー
 	関係の元となったオブジェクト。
	または、トリガーに from オブジェクトが与えられなかった場合は undef。
get_from_state

遷移の実行時に、遷移元の状態は、遷移前のオブジェクトの状態になります。

my $from_state = $trigger->get_from_state()

 戻り値: スカラー
 	オブジェクトの遷移元の状態。
	または、トリガーに遷移元の状態が与えられなかった場合は undef。
get_host

トリガー起動時にユーザーが接続された IBM Rational Change インストールのホスト名を取得します。 これは、IBM Rational Change サーバーへの新しい接続を作成するときに役に立ちます。

my $host = $trigger->get_host()

 戻り値: スカラー
 	トリガーを起動した IBM Rational Change インストールのホスト名。
	または、ホスト名が与えられなかった場合は undef。
get_object_id

トリガーを起動させたオブジェクトの ID 番号を取得します。

 オブジェクト ID は以下のタイプのいずれかです。 
	problem_number
	task_number
	cvid

my $object_id = $trigger->get_object_id()

 戻り値: スカラー
 	トリガーの起動の原因となったオブジェクトのオブジェクト ID。
	または、トリガーでオブジェクト ID が与えられなかった場合は undef。
get_object_type

トリガーを起動させたオブジェクトのタイプを取得します。

 オブジェクト・タイプは以下のタイプのいずれかです。
	CCM_PROBLEM
	CCM_TASK
	CCM_OBJECT

my $object_type = $trigger->get_object_type()

 戻り値: スカラー
 	トリガーが作用するオブジェクト・タイプ。
	または、トリガーでオブジェクト・タイプが与えられなかった場合は undef。
get_port

トリガー起動時にユーザーが接続された IBM Rational Change インストールのポートを取得します。 これは、CS サーバーへの新しい接続を作成するときに役に立ちます。

my $port = $trigger->get_port()

 戻り値: スカラー
 	トリガーを起動した IBM Rational Change インストールのポート。
	または、ポートが与えられなかった場合は undef。
get_protocol

トリガー起動時にユーザーが接続された IBM Rational Change インストールのプロトコルを取得します。 プロトコルは、サーバーの設定方法によって、http または https のいずれかのタイプになります。 これは、CS サーバーへの新しい接続を作成するときに役に立ちます。

my $protocol = $trigger->get_protocol()

 戻り値: スカラー
 	トリガーを起動した IBM Rational Change インストールのプロトコル・タイプ。
	または、プロトコルが与えられなかった場合は undef。
get_relation_action

関連性が作用している動作を取得します。 これは CREATE_RELATION または DELETE_RELATION のいずれかです。

my $relation_action = $trigger->get_relation_action()

 戻り値: スカラー
 	トリガーが作用している関係アクション。
	または、トリガーでオブジェクト・タイプが与えられなかった場合は undef。
get_relation_name

トリガーが作動している関連の名前を取得します。

my $relation_name = $trigger->get_relation_name()

 戻り値: スカラー
 	トリガーが作用している関係名。
	または、トリガーでオブジェクト・タイプが与えられなかった場合は undef。
get_relation_type

トリガーが作動している関連のタイプを取得します。

 関係のタイプ:
	CCM_PROBLEM_PROBLEM: 問題 --> 問題の関係。
	CCM_PROBLEM_TASK:    問題 --> タスクの関係。
	CCM_PROBLEM_OBJECT:  問題 --> オブジェクトの関係。
	CCM_TASK_PROBLEM:    タスク    --> 問題の関係。
	CCM_TASK_TASK:       タスク    --> タスクの関係。
	CCM_TASK_OBJECT:     タスク    --> オブジェクトの関係。
	CCM_OBJECT_PROBLEM:  オブジェクト  --> 問題の関係。
	CCM_OBJECT_TASK:     オブジェクト  --> タスクの関係。
	CCM_OBJECT_OBJECT:   オブジェクト  --> オブジェクトの関係。

my $relation_type = $trigger->get_relation_type()

 戻り値: スカラー
 	トリガーが作用している関係のタイプ。
	または、トリガーでオブジェクト・タイプが与えられなかった場合は undef。
get_requested_attributes

XML データ内に含まれていたすべての要求されたトリガー属性を収集し、ハッシュに格納します。 これらの要求された属性は、ライフサイクル・エディターからトリガーに送られるように明確に要求された属性です。 トリガーが遷移前 (pre transition) トリガーの場合、要求された属性値は変更が行われる前の値です。 トリガーがポスト・トリガー (post modify、post transition または post submit) の場合、要求された属性値は修正後の値です。

my %trigger_attributes = $trigger->get_requested_attributes();

 戻り値: ハッシュ
	ライフサイクル・エディターによってトリガーに送信するように要求されたすべての属性。
	または、要求されたトリガー属性が XML ファイルに定義されていない場合は undef。
get_role

トリガーを起動させたユーザーのロールを取得します。

my $role = $trigger->get_role()

 戻り値: スカラー
 	トリガーを起動させたユーザーのロール。
	または、トリガーでロールが与えられなかった場合は undef。
get_smtp_server

トリガーによって E メールを送出するときに使用される pt.cfg ファイルに定義されている SMTP サーバーを取得します。

my $smtp_server = $trigger->get_smtp_server();

 戻り値: スカラー
  	PERL スクリプトにより E メールを送信するために使用される SMTP サーバー。
 	または、トリガーに from オブジェクトが与えられなかった場合は undef。
get_subscriber_email_addresses

このトリガーがサブスクリプション・トリガーに対して起動した場合は、変更される CR にサブスクライブしている登録者の E メール・アドレスのリストを取得します。サブスクリプション以外のすべてのトリガーでは、このフィールドは undef になります。

my $token = $trigger->get_subscriber_email_addresses()

 戻り値: スカラー
 当該 CR の登録者の E メール・アドレスのリスト。
	または、トリガーでトークンが与えられなかった場合は undef。
get_to_object

関係作成の実行時に、これは、関係が指すオブジェクトです。

my $to_object = $trigger->get_to_object()

 戻り値: スカラー
 関係の遷移先オブジェクト、または undef (トリガーで遷移先オブジェクトが指定されなかった場合)。
get_to_state

遷移の実行時に、遷移先の状態は、オブジェクトの最終的な状態になります。

my $to_state = $trigger->get_to_state()

 戻り値: スカラー
 オブジェクトの遷移先の状態、または undef (トリガーで遷移先の状態が指定されなかった場合)。
get_token

トリガーを起動させたユーザーのトークンを取得します。

my $token = $trigger->get_token()

 戻り値: スカラー
 	トリガーを起動させたユーザーのトークン。
	または、トリガーでトークンが与えられなかった場合は undef。
get_user

トリガーを起動させたユーザーのユーザー名を取得します。

my $user = $trigger->get_user()

 戻り値: スカラー
 	トリガーを起動させたユーザーのユーザー名。
	または、トリガーでユーザー名が与えられなかった場合は undef。
set_admin_token

このクラス・インスタンスの「admin トークン」(admin token) プロパティーを設定します。

$trigger->set_admin_token($value);

 パラメーター:
	value - admin トークンの新しい値。
set_admin_user

このクラス・インスタンスの「admin ユーザー名」(admin username) プロパティーを設定します。

$trigger->set_admin_user($value);

 パラメーター:
	value - admin ユーザー名の新しい値。
set_database

このクラス・インスタンスの「データベース」(database) プロパティーを設定します。

$trigger->set_database($value);

 パラメーター: 
	value - データベースの新しい値。
set_database_uid

このクラス・インスタンスの「データベース uid」(database uid) プロパティーを設定します。

$trigger->set_database_uid($value);

 パラメーター: 
	value - データベース uid の新しい値。
set_dcm_delimiter

このクラス・インスタンスの「DCM 区切り文字」(DCM delimiter) プロパティーを設定します。

$trigger->set_dcm_delimiter($value);

 パラメーター: 
	value - DCM 区切り文字の新しい値。
set_from_email_addr

このクラス・インスタンスの「from E メール・アドレス」(from email addr) プロパティーを設定します。 これはトリガー XML ファイルを構文解析するときに設定されますが、必要に応じて上書きできます。

$trigger->set_from_email_addr($value);

 パラメーター:
	value - from オブジェクトの新しい値。
set_from_object

このクラス・インスタンスの「from オブジェクト」(from_object) プロパティーを設定します。

$trigger->set_from_object($value);

 パラメーター:
	value - from オブジェクトの新しい値。
set_from_state

このクラス・インスタンスの「from 状態」(from_state) プロパティーを設定します。

$trigger->set_from_state($value);

 パラメーター:
	value - from 状態の新しい値。
set_host

このクラス・インスタンスの「ホスト名」(hostname) プロパティーを設定します。

$trigger->set_host($value);

 パラメーター:
	value - ホストの新しい値。
set_object_id

このクラス・インスタンスの「オブジェクト ID」(object_id) プロパティーを設定します。

$trigger->set_object_id($value);

 パラメーター:
	value - オブジェクト ID の新しい値。
set_object_type

このクラス・インスタンスの「オブジェクト・タイプ」(object_type) プロパティーを設定します。

$trigger->set_object_type($value);

 パラメーター:
	value - オブジェクト・タイプの新しい値。
set_port

このクラス・インスタンスの「ポート」(port) プロパティーを設定します。

$trigger->set_port($value);

 パラメーター:
	value - ポートの新しい値。
set_protocol

このクラス・インスタンスの「プロトコル」(protocol) プロパティーを設定します。

$trigger->set_protocol($value);

 パラメーター:
	value - プロトコルの新しい値。
set_relation_action

このクラス・インスタンスの「関連アクション」(relation_action) プロパティーを設定します。

$trigger->set_relation_action($value);

 パラメーター:
	value - 関係アクションの新しい値。
set_relation_name

このクラス・インスタンスの「関連名」(relation_name) プロパティーを設定します。

$trigger->set_relation_name($value);

 パラメーター:
	value - 関係名の新しい値。
set_relation_type

このクラス・インスタンスの「関連タイプ」(relation_type) プロパティーを設定します。 $trigger->set_relation_type($value);

 パラメーター:
	value - 関係タイプの新しい値。
set_role

このクラス・インスタンスの「ロール」(users role) プロパティーを設定します。

$trigger->set_role($value);

 パラメーター:
	value - ユーザー・ロールの新しい値。
set_smtp_server

このクラス・インスタンスの「SMTP サーバー」プロパティーを設定します。 これはトリガー XML ファイルを構文解析するときに設定されますが、必要に応じて上書きできます。

$trigger->set_smtp_server($value);

 パラメーター:
	value - from オブジェクトの新しい値。
set_subscriber_email_addresses

このクラス・インスタンスの「登録者 E メール・アドレス」(subscriber email addresses) プロパティーを設定します。

$trigger->set_subscriber_email_addresses($value);

 パラメーター:
value - 登録者 E メール・アドレスの新しい値。
set_to_object

このクラス・インスタンスの「to オブジェクト」(to_object) プロパティーを設定します。

$trigger->set_to_object($value);

 パラメーター:
	value - to オブジェクトの新しい値。
set_to_state

このクラス・インスタンスの「to 状態」(to_state) プロパティーを設定します。

$trigger->set_to_state($value);

 パラメーター:
	value - to 状態の新しい値。
set_token

このクラス・インスタンスの「トークン」(token) プロパティーを設定します。

$trigger->set_token($value);

 パラメーター:
	value - トークンの新しい値。
set_user

このクラス・インスタンスの「ユーザー名」(username) プロパティーを設定します。

$trigger->set_user($value);

 パラメーター:
	value - ユーザー名の新しい値。