名前

ChangeSynergy::apiESignatureMessage


詳細

電子署名により、IBM Rational Change ユーザーは重要な局面で責任を持つ目的で変更依頼に署名できます。 この機能は、Enterprise Change Proposal System (ECPS) インテグレーションでは DOORS の電子署名に準拠するために必要ですが、IBM Rational Change にも適用できます。


メソッド

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

new
 sub new(xmlData)

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

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

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

電子署名の属性プロパティーを取得します。

my $attribtue = $eSigMessage->getAttribute()

 戻り値: スカラー
 	電子署名の属性プロパティー。
getComment

電子署名のコメント・プロパティーを取得します。これは署名についてのコメントです。

my $comment = $eSigMessage->getComment()

 戻り値: スカラー
 	電子署名のコメント・プロパティー。
getCreateTime

電子署名の作成時刻プロパティーを取得します。これは署名を作成した時刻です。

my $createTime = $eSigMessage->getCreateTime()

 戻り値: スカラー
 	電子署名の作成時刻プロパティー。
getCvid

電子署名の cvid プロパティーを取得します。これは不具合を示す識別番号です。

my $cvid = $eSigMessage->getCvid()

 戻り値: スカラー
 	電子署名の cvid プロパティー。
getDate

電子署名の日付プロパティーを取得します。これは署名をした日付です。

my $date = $eSigMessage->getDate()

 戻り値: スカラー
 	電子署名の日付プロパティー。
getDateString

電子署名の日付プロパティーを取得します。これは署名をした日付です。

my $date = $eSigMessage->getDate()

 パラメーター:
	format  - フォーマット文字列。これが undef の場合、デフォルトは "%Y/%m/%d %I:%M:%S %p" です。
printf のフォーマット文字列に似たフォーマット文字列。フォーマット・コードは、
	その先頭にパーセント (%) 記号が付き、対応する POSIX コンポーネントに置き換えられます。
	フォーマット文字列内のその他の文字は変更なく、返される文字列にそのままコピーされます。
	詳細については strftime 関数を参照してください。フォーマットのフォーマット・コードの
	値と意味を以下に記載します。
	
	%a: 省略形の曜日名
	%A: 完全な曜日名
	%b: 省略形の月名
	%B: 完全な月名
	%c: ローカルの日時表記
	%d: 10 進数で表記した日にち (0 から 31)
	%D: この CTime 内の総日数
	%H: 24 時間フォーマットで表記した時間 (0 から 23)
	%I: 12 時間フォーマットで表記した時間 (0 から 12)
	%j: 10 進数で表記した年間通算日 (001 から 336)
	%m: 10 進数で表記した月 (0 から 12)
	%M: 10 進数で表記した分 (0 から 59)
	%p: 12 時間クロックでの現在のロケールの A.M./P.M. 標識
	%S: 10 進数で表記した秒 (00 から 59)
	%U: 10 進数で表記した年間通算週 (00 から 53)。週の最初の曜日は日曜日
	%w: 10 進数で表記した曜日 (0 から 6。日曜日が 0)
	%W: 10 進数で表記した年間通算週 (00 から 53)。週の最初の曜日は月曜日
	%x: 現在のロケールの日付表記
	%X: 現在のロケールの時刻表記
	%y: 先頭の 2 桁を省略した年の 10 進表記 (00 から 99)
	%Y: 4 桁の年の 10 進表記
	%z、%Z: タイム・ゾーン名またはその省略語。タイム・ゾーンが不明の場合は文字なし
%%: パーセント記号
戻り値: スカラー
	電子署名の日付プロパティー。
getFullname

電子署名のフルネーム・プロパティーを取得します。これは署名をしたユーザーのフルネームです。

my $fullname = $eSigMessage->getFullname()

 戻り値: スカラー
 	電子署名のフルネーム・プロパティー。
getPurpose

電子署名の目的プロパティーを取得します。これは署名の目的です。

my $purpose = $eSigMessage->getPurpose()

 戻り値: スカラー
 	電子署名の目的プロパティー。
getUnencodedComment

電子署名のコメント・プロパティーを取得します。これは署名についてのコメントです。 テキスト値はコード化されていない XML です。

my $comment = $eSigMessage->getUnencodedComment()

 戻り値: スカラー
 	電子署名のコメント・プロパティー。
getUsername

電子署名のユーザー名プロパティーを取得します。これは署名をしたユーザーのユーザー名です。

my $username = $eSigMessage->getUsername()

 戻り値: スカラー
 	電子署名のユーザー名プロパティー。
getXmlData

この apiESignatureMessage クラスの作成に使用される XML データを取得します。

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

my $xmlData = $eSigMessage->getXmlData()

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