名前

ChangeSynergy::apiTransitions


詳細

apiTransitions クラスは現在のユーザーの遷移情報を格納します。

以下の API 関数を使用すると、利用可能な遷移が取得されます。

 AttributeModifyCRData()
 ModifyCRData()
 GetCRData().
 表示データ・フォーマット:
  from_state2to_state:label|from_state2to_state:label|ADMIN_ROLE...
 遷移データ・フォーマット:
  from_state2to_state:label
 SubmitCRData() という API 関数を使用するとき、提出フォーム・データ、すなわち「Submit to state,」を使用できます。
 提出データ・フォーマット:
  START_HERE2to_state:label
 CopyCRData() という API 関数を使用するとき、コピー・フォーム・データ、すなわち「Submit to state,」と「Submit relation name,」を使用できます。
 
  コピー・データ・フォーマット:
  COPY_relation_name2to_state:label

メソッド

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

new
 sub new(xmlData)

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

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

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

この遷移の「from 状態」(from state) を取得します。 この値を使用して、現在の「crstatus」属性値を表示します。

my $fromState = $transitions->getFromState()

 戻り値: スカラー
 	現在の「crstatus」属性値。
getName

この遷移の「説明ラベル」(descriptive label) を取得します。

my $name = $transitions->getName()

 戻り値: スカラー
 	この遷移の名前。
getRelation

コピー操作に使用される「コピー関連名」(copy relation name) を取得します。

my $transition = $transitions->getTransition()

 戻り値: スカラー
 	コピー関係名。
getToState

この遷移の「to 状態」(to state) を取得します。 この値を使用して、TransitionCR() 関数を呼び出す前に「crstatus」属性を設定します。

my $toState = $transitions->getToState()

 戻り値: スカラー
 	この遷移の to 状態。
getTransition

この遷移の「遷移テンプレート名」(transition template name) を取得します。

my $transition = $transitions->getTransition()

 戻り値: スカラー
 	遷移テンプレート名。
getXmlData

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

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

my $xmlData = $transitions->getXmlData()

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

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

$transitions->setFromState($value)

 パラメーター:
	value - from 状態プロパティーの新しい値。
setName

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

$transitions->setName($value)

 パラメーター:
	value - 名前プロパティーの新しい値。
setRelation

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

$transitions->setRelation($value)

 パラメーター:
	value - 遷移コピー関係名の新しい値。
setToState

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

$transitions->setToState($value)

 パラメーター:
	value - to 状態プロパティーの新しい値。
setTransition

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

$transitions->setTransition($value)

 パラメーター:
	value - 遷移テンプレート名の新しい値。